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

Extends: anychart.core.stock.scrollerSeries.Base

StepArea Series Class.
Learn more about StepArea series

Methods Overview

Coloring
fill()	Fill settings.
hatchFill()	Hatch fill settings.
selectFill()	Fill settings in selected mode.
selectHatchFill()	Hatch fill settings in selected mode.
selectStroke()	Stroke settings in selected mode.
stroke()	Stroke settings.
Data
data()	Data settings.
Events
listen()	Adds an event listener.
listenOnce()	Adds a single time event listener.
removeAllListeners()	Removes all listeners.
unlisten()	Removes the listener.
unlistenByKey()	Removes the listener by the key.
Export
print()	Prints all elements.
Interactivity
enabled()	Element state (enabled or disabled).
Scales
yScale()	Y-scale settings.
Series
rendering()	Rendering settings
seriesType()	Switch the series type
Size and Position
bottom()	Bottom bound setting.
bounds()	Bounds settings.
getPixelBounds()	Returns pixel bounds.
height()	Height setting.
left()	Left bound setting.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
right()	Right bound setting.
stepDirection()	Step direction settings.
top()	Top bound setting.
width()	Width setting.
zIndex()	Z-index of the element.

Methods Description

bottom

bottom()

Getter for element bottom bound setting.

Returns:

number | string | undefined - Current element's bottom bound setting.

bottom(value)

Sets element bottom bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Bottom bound setting for the element.

Returns:

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

Try it:

Usage sample

bounds

bounds()

Getter for the element bounds settings.

Returns:

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

bounds(value)

Sets bounds of the element using one parameter.

Params:

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

Returns:

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

Try it:

Usage sample

bounds(x, y, width, height)

Setter for the 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.StepArea - 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 current 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, 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 - 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.StepArea - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Usage sample

Name	Type	Default	Description
value	boolean	true	Value to set.

fill

fill()

Getter for the series fill color.

Detailed description

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

Returns:

anychart.graphics.vector.Fill - The fill color.

Try it:

Usage sample

fill(value)

Setter for fill settings using an object or a string. Learn more about coloring.

Params:

Name	Type	Description
value	anychart.graphics.vector.Fill	Color as an object or a string.

Returns:

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

Try it:

fill(fillFunction)

Setter for fill settings using function.

Params:

Name	Type	Default	Description
fillFunction	function	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like `function(){ // this.index - series index. // this.sourceColor - color returned by fill() getter. // this.iterator - series point iterator. return fillValue; // type anychart.graphics.vector.Fill }`.

Returns:

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

Try it:

Usage sample

fill(color, opacity)

Fill color with opacity.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Description
color	string	Color as a string.
opacity	number	Color opacity.

Returns:

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

Try it:

Usage sample

fill(keys, angle, mode, opacity)

Linear gradient fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

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

Try it:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)

Radial gradient fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

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

Try it:

Usage sample

fill(imageSettings)

Image fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

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

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.

hatchFill

hatchFill()

Getter for the hatch fill settings.

Detailed description

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

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The hatch fill.

See listing

var currentHatchFill = series.hatchFill();

hatchFill(patternFillOrType, color, thickness, size)

Setter for hatch fill settings. Learn more about hatch fill settings.

Params:

Name	Type	Default	Description
patternFillOrType	anychart.graphics.vector.PatternFill \| anychart.graphics.vector.HatchFill \| function \| anychart.graphics.vector.HatchFill.HatchFillType \| string	false	PatternFill or HatchFill instance or type of hatch fill.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

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

Try it:

Usage sample

height

height()

Getter for element height setting.

Returns:

number | string | undefined - Current element's height setting.

height(value)

Sets element height setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Height setting for the element.

Returns:

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

Try it:

Usage sample

left

left()

Getter for element left bound setting.

Returns:

number | string | undefined - Current element's left bound setting.

left(value)

Sets element left bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method. Function that looks like `function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }`.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

maxHeight

maxHeight()

Getter for maximum height.

Returns:

number | string | null - Current element's maximum height.

maxHeight(value)

Setter for maximum height.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for maximum width.

Returns:

number | string | null - Current element's maximum width.

maxWidth(value)

Setter for maximum width.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

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

Try it:

Usage sample

minHeight

minHeight()

Getter for minimum height.

Returns:

number | string | null - Current element's minimum height.

minHeight(value)

Setter for 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
value	number \| string \| null	null	Value to set.

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for minimum width.

Returns:

number | string | null - Current element's minimum width.

minWidth(value)

Setter for 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
value	number \| string \| null	null	Value to set.

Returns:

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

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

Prints all elements on related stage.

Params:

Name	Type	Default	Description
paperSizeOrOptions	anychart.graphics.vector.PaperSize \| Object		Paper size or object with options.
landscape	boolean	false	Flag of landscape.

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

Name	Type	Description
type	string	Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

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(value)Since version 7.13.0

Setter for the series rendering settings.

Params:

Name	Type	Description
value	Object \| function	Value to set.

Returns:

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

Try it:

Usage sample

right

right()

Getter for element right bound setting.

Returns:

number | string | undefined - Current element's right bound setting.

right(value)

Sets element right bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

selectFill

selectFill()

Getter for the series fill color in selected mode.

Detailed description

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

Returns:

anychart.graphics.vector.Fill - The fill color.

Try it:

Usage sample

selectFill(value)

Setter for fill settings in selected mode using an array or a string. Learn more about coloring.

Params:

Name	Type	Description
value	anychart.graphics.vector.Fill	Color as an array or a string.

Returns:

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

Try it:

selectFill(fillFunction)

Setter for fill settings in selected mode using function.

Params:

Name	Type	Default	Description
fillFunction	function	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like `function(){ // this.index - series index. // this.sourceColor - color returned by fill() getter. // this.iterator - series point iterator. return fillValue; // type anychart.graphics.vector.Fill }`.

Returns:

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

Try it:

Usage sample

selectFill(color, opacity)

Fill color in selected mode with opacity.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Description
color	string	Color as a string.
opacity	number	Color opacity.

Returns:

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

Try it:

Usage sample

selectFill(keys, angle, mode, opacity)

Linear gradient fill in selected mode. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

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

Try it:

Usage sample

selectFill(keys, cx, cy, mode, opacity, fx, fy)

Radial gradient fill in selected mode. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

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

Try it:

Usage sample

selectFill(imageSettings)

Image fill in selected mode. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

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

Try it:

Usage sample

selectHatchFill

selectHatchFill()

Getter for the hatch fill settings in selected mode.

Detailed description

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

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The hatch fill.

See listing

var currentSelectHatchFill = series.selectHatchFill();

selectHatchFill(patternFillOrType, color, thickness, size)

Setter for hatch fill settings in selected mode. Learn more about hatch fill settings.

Params:

Name	Type	Description
patternFillOrType	anychart.graphics.vector.PatternFill \| anychart.graphics.vector.HatchFill \| function \| anychart.graphics.vector.HatchFill.HatchFillType \| string	PatternFill or HatchFill instance or type of hatch fill.
color	string	Color.
thickness	number	Thickness.
size	number	Pattern size.

Returns:

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

Try it:

Usage sample

selectStroke

selectStroke()

Getter for the stroke settings in selected mode.

Detailed description

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

Returns:

anychart.graphics.vector.Stroke - The stroke settings.

Try it:

Usage sample

selectStroke(strokeFunction)

Setter for series stroke in selected mode by function.

Params:

Name	Type	Default	Description
strokeFunction	function	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like `function(){ // this.index - series index. // this.sourceColor - color returned by fill() getter. // this.iterator - series point iterator. return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill }`.

Returns:

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

Try it:

Usage sample

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

Setter for stroke settings in selected mode. Learn more about stroke settings.

Params:

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

Returns:

anychart.core.stock.scrollerSeries.StepArea - 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(value)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
value	string	Series type.

Returns:

anychart.core.stock.scrollerSeries.StepArea - 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(value)Since version 7.13.0

Setter for the step direction.

Params:

Name	Type	Default	Description
value	anychart.enums.StepDirection \| string	"center"	Value to set.

Returns:

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

Try it:

Usage sample

stroke

stroke()

Getter for the stroke settings.

Detailed description

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

Returns:

anychart.graphics.vector.Stroke - The stroke settings.

Try it:

Usage sample

stroke(strokeFunction)

Setter for series stroke by function.

Params:

Name	Type	Default	Description
strokeFunction	function	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like `function(){ // this.index - series index. // this.sourceColor - color returned by fill() getter. // this.iterator - series point iterator. return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill }`.

Returns:

anychart.core.stock.scrollerSeries.StepArea - 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 \| function \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

top

top()

Getter for element top bound setting.

Returns:

number | string | undefined - Current element's top bound setting.

top(value)

Sets element top bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

Removes a listener added using listen() or listenOnce() methods.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

unlistenByKey

unlistenByKey(key)

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

Name	Type	Description
key	Object	The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

width

width()

Getter for element width setting.

Returns:

number | string | undefined - Current element's width setting.

width(value)

Sets element width setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Width setting for the element.

Returns:

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

Try it:

Usage sample

yScale

yScale()Since version 7.7.0

Getter for the current Y-scale.

Returns:

anychart.scales.ScatterBase - Series Y-scale.

See listing

var lineScroller = chart.scroller();
var scrollerSeries = lineScroller.line(data);
scrollerSeries.yScale();

yScale(value)Since version 7.7.0

Setter for the Y-scale.

Params:

Name	Type	Description
value	anychart.scales.ScatterBase	Value to set.

Returns:

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

Try it:

Usage sample

zIndex

zIndex()

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Usage sample

zIndex(value)

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
value	number	0	Value to set.

Returns:

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

Try it:

Usage sample