class anychart.core.stock.scrollerSeries.StepLine Improve this Doc

Extends: anychart.core.stock.scrollerSeries.Base

StepLine Series Class.
Learn more about StepLine series

Methods Overview

Specific settings
labels()	Labels settings.
Coloring
colorScale()	Color scale settings.
stroke()	Stroke settings.
Data
data()	Data settings.
Interactivity
enabled()	Element state (enabled or disabled).
normal()	Normal state settings.
selected()	Hovered state settings.
Point Elements
maxLabels()	Maximum labels settings.
minLabels()	Minimum labels settings.
Scales
yScale()	Y-scale settings.
Series
allowPointSettings()	Allows to set point settings from data.
rendering()	Rendering settings
seriesType()	Switch the series type
Size and Position
bottom()	Bottom bound settings.
bounds()	Bounds settings.
getPixelBounds()	Returns pixel bounds.
height()	Height settings.
left()	Left bound settings.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
right()	Right bound settings.
stepDirection()	Step direction settings.
top()	Top bound settings.
width()	Width settings.
zIndex()	Z-index of the element.

Methods Description

allowPointSettings

allowPointSettings()Since version 8.2.1

Getter for the allowPointSettings flag.

Returns:

boolean - Returns allowPointSettings flag.

See listing

var scroller = chart.scroller();
var series = scroller.column(data);
var allowPointSettings = series.allowPointSettings();

allowPointSettings(enabled)Since version 8.2.1

Setter for the allowPointSettings flag.

Detailed description

Reconfigure series by the allowPointSettings flag.
The following series support allowPointSettings flag:

If the value isn't set to anychart.core.stock.series.Base#allowPointSettings then the series gets the settings from anychart#stock.
Note: Other series cannot be affected by the allowPointSettings flag.

Params:

Name	Type	Default	Description
enabled	boolean	false	Allows to set individual point settings.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

bottom

bottom()

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.

bottom(bottom)

Setter for element bottom bound settings.

Params:

Name	Type	Default	Description
bottom	number \| string \| null	null	Bottom bound settings for the element.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Returns self for method chaining.

Try it:

Usage sample

bounds

bounds()

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.

bounds(bounds)

Setter for bounds of the element using one parameter.

Params:

Name	Type	Description
bounds	anychart.utils.RectObj \| anychart.math.Rect \| anychart.core.utils.Bounds	Bounds of element.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

bounds(x, y, width, height)

Setter for element bounds settings.

Params:

Name	Type	Default	Description
x	number \| string	null	X-coordinate.
y	number \| string	null	Y-coordinate.
width	number \| string	null	Width.
height	number \| string	null	Height.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

colorScale

colorScale()Since version 8.3.0

Getter for the color scale.

Returns:

anychart.scales.LinearColor | anychart.scales.OrdinalColor - Color scale instance.

See listing

var series = scroller.line(mapping);
var colorScale = series.colorScale();

colorScale(settings)Since version 8.3.0

Setter for the color scale.

Params:

Name	Type	Description
settings	anychart.scales.LinearColor \| anychart.scales.OrdinalColor \| Object \| anychart.enums.ScaleTypes \| string	Color scale to set.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

data

data()Since version 7.7.0

Gets data for the scroller series.

Returns:

anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string - Returns mapping.

data(value, mappingSettings, csvSettings)Since version 7.7.0

Sets data for the scroller series.

Params:

Name	Type	Description
value	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Data for the scroller series.
mappingSettings	Object.<string, ({column: number, type: (anychart.enums.AggregationType\|string), weights: number}\|number)>	Mapping settings. An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType\|string - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettings	Object	CSV parser settings if the string is passed.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

getPixelBounds

getPixelBounds()

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

height

height()

Getter for element height settings.

Returns:

number | string | undefined - Element's height setting.

height(height)

Setter for element height setting.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Height settings for the element.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Returns self for method chaining.

Try it:

Usage sample

labels

labels()Since version 8.2.0

Getter for chart labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels instance.

labels(settings)Since version 8.2.0

Setter for chart labels.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Axis labels.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

left

left()

Getter for element left bound settings.

Returns:

number | string | undefined - Element's left bound setting.

left(left)

Setter for element left bound settings.

Params:

Name	Type	Default	Description
left	number \| string \| null	null	Left bound setting for the element.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Returns self for method chaining.

Try it:

Usage sample

maxHeight

maxHeight()

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.

maxHeight(height)

Setter for the maximum height.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Maximum height to set.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

maxLabels

maxLabels()Since version 8.2.0

Getter for maximum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

maxLabels(settings)Since version 8.2.0

Setter for maximum labels.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Maximum labels settings.

Returns:

anychart.core.stock.series.Base | anychart.core.ui.LabelsFactory - Self instance for method chaining.

maxWidth

maxWidth()

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.

maxWidth(width)

Setter for the maximum width.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Maximum width to set.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

minHeight

minHeight()

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.

minHeight(height)

Setter for the minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Minimum height to set.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

minLabels

minLabels()Since version 8.2.0

Getter for minimum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

minLabels(settings)Since version 8.2.0

Setter for minimum labels.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Minimum labels settings.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

minWidth

minWidth()

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.

minWidth(width)

Setter for the minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Minimum width to set.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

normal

normal()Since version 8.0.0

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Usage sample

normal(settings)Since version 8.0.0

Setter for normal state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

rendering

rendering()Since version 7.13.0

Getter for the series rendering.

Returns:

anychart.core.series.RenderingSettings - Rendering settings.

Try it:

Usage sample

rendering(settings)Since version 7.13.0

Setter for the series rendering settings.

Params:

Name	Type	Description
settings	Object \| function	Rendering settings to set.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

right

right()

Getter for element right bound settings.

Returns:

number | string | undefined - Element's right bound setting.

right(right)

Setter for element right bound setting.

Params:

Name	Type	Default	Description
right	number \| string \| null	null	Right bound setting for the element.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Returns self for method chaining.

Try it:

Usage sample

selected

selected()Since version 8.0.0

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Usage sample

selected(settings)Since version 8.0.0

Setter for selected state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

seriesType

seriesType()Since version 7.10.0

Getter for switching of the series type.

Returns:

string - Series type.

Try it:

Usage sample

seriesType(type)Since version 7.10.0

Setter for switching of the series type.

Detailed description

You can use seriesType() method to fast switching series type. Note: The switching of series type resets markers and labels settings.

Params:

Name	Type	Description
type	string	Series type.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

stepDirection

stepDirection()Since version 7.13.0

Getter for the step direction.

Returns:

anychart.enums.StepDirection | string - The step direction.

See listing

var direction = series.stepDirection();

stepDirection(direction)Since version 7.13.0

Setter for the step direction.

Params:

Name	Type	Default	Description
direction	anychart.enums.StepDirection \| string	'center'	Value to set.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

stroke

stroke()

Getter for stroke settings.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.

Try it:

Usage sample

stroke(strokeFunction)

Setter for series stroke by function.

Params:

Name	Type	Default	Description
strokeFunction	function():anychart.graphics.vector.Stroke\|anychart.graphics.vector.ColoredFill	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like: function(){ // Context: // this.x - X value. Type is "date-time" // this.value - value. Type is number // this.index - point index (iterator.getIndex();). Type is number // this.sourceColor - source color of the point. // this.iterator - series point iterator. Type is instance of anychart.data.TableIterator // this.plot - link to the plot. Type is instance of anychart.core.stock.Plot // this.chart - link to the chart. Type is instance of anychart.charts.Stock // this.name - series name. Type is string Additional fields if colorScale () is set: // this.scaledColor - color from this.colorScale for this point of the series. Type is string // this.colorScale - series color scale. Type is instance of anychart.scales.LinearColor or anychart.scales.OrdinalColor // Methods from anychart.format.Context are used for an access to series. return strokeValue; // Type is anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill }

Name

Type

Default

Description

strokeFunction

function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill

function() {
 return anychart.color.darken(this.sourceColor);
}

Function that looks like:

function(){
     // Context:
     // this.x - X value. Type is "date-time"
     // this.value - value. Type is number
     // this.index - point index (iterator.getIndex();). Type is number
     // this.sourceColor - source color of the point.
     // this.iterator - series point iterator. Type is instance of anychart.data.TableIterator
     // this.plot - link to the plot. Type is instance of anychart.core.stock.Plot
     // this.chart - link to the chart. Type is instance of anychart.charts.Stock
     // this.name - series name. Type is string

     Additional fields if colorScale () is set:

     // this.scaledColor - color from this.colorScale for this point of the series. Type is string
     // this.colorScale - series color scale. Type is instance of anychart.scales.LinearColor or anychart.scales.OrdinalColor

     // Methods from anychart.format.Context are used for an access to series.
   return strokeValue; // Type is anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
}

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

stroke(color, thickness, dashpattern, lineJoin, lineCap)

Setter for stroke settings. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	string \| anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

stroke(settings)

Setter for stroke using an object.

Params:

Name	Type	Description
settings	Object	Stroke settings from anychart.graphics.vector.Stroke.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

top

top()

Getter for element top bound settings.

Returns:

number | string | undefined - Element's top bound setting.

top(top)

Setter for element top bound settings.

Params:

Name	Type	Default	Description
top	number \| string \| null	null	Top bound setting for the element.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Returns self for method chaining.

Try it:

Usage sample

width

width()

Getter for element width settings.

Returns:

number | string | undefined - Element's width setting.

width(width)

Setter for element width setting.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Width settings for the element.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Returns self for method chaining.

Try it:

Usage sample

yScale

yScale()Since version 7.7.0

Getter for the Y-scale.

Returns:

anychart.scales.ScatterBase - Series Y-scale.

See listing

var scroller = chart.scroller();
var series = scroller.line(data);
var yScale = series.yScale();

yScale(settings)Since version 7.7.0

Setter for the Y-scale.

Params:

Name	Type	Default	Description
settings	anychart.scales.ScatterBase \| Object \| anychart.enums.ScaleTypes \| string	anychart.scales.Linear	Scale settings to set.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample

zIndex

zIndex()

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Usage sample

zIndex(zIndex)

Setter for the Z-index of the element.

Detailed description

The bigger the index - the higher the element position is.

Params:

Name	Type	Default	Description
zIndex	number	0	Value to set.

Returns:

anychart.core.stock.scrollerSeries.StepLine - Self instance for method chaining.

Try it:

Usage sample