class anychart.core.stock.Scroller Improve this Doc

Stock scroller class. Adds series drawing to UI Scroller.

Methods Overview

Specific settings
addSeries()	Add series to chart.
allowRangeChange()	Mode of the range changing.
defaultSeriesType()	Default series type.
getSeriesAt()	Gets the series by its index.
getSeriesCount()	Returns series count.
removeAllSeries()	Removes all series from chart.
removeSeries()	Removes one of series from chart by its id.
removeSeriesAt()	Removes one of series from chart by its index.
thumbs()	Thumbs settings.
Axes and Scales
xAxis()	X-axis settings.
yScale()	Y-scale settings.
Chart Coloring
hatchFillPalette()	Hatch fill palette settings.
palette()	Palette settings.
Coloring
fill()	Fill settings.
outlineStroke()	Stroke settings.
selectedFill()	Fill 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
autoHide()	Auto hide setting.
enabled()	Element state (enabled or disabled).
Series
area()	Adds Area series.
candlestick()	Adds Candlestick series.
column()	Adds Column series.
getSeries()	Gets series by its id.
hilo()	Adds HiLo series.
jumpLine()	Adds Jump Line series.
line()	Adds Line series.
marker()	Adds Marker series.
ohlc()	Adds OHLC series.
rangeArea()	Adds Range Area series.
rangeColumn()	Adds Range Column series.
rangeSplineArea()	Adds Range Column series.
rangeStepArea()	Adds Range Step area series.
spline()	Adds Range Step area series.
splineArea()	Adds Spline Area series.
stepArea()	Adds Step Area series.
stepLine()	Adds Step Line series.
stick()	Adds Stick series.
Size and Position
height()	Scroller height.
maxHeight()	Scroller maximum height.
minHeight()	Scroller minimum height.
orientation()	Scroller orientation.
zIndex()	Z-index of the element.
Technical Indicators
adl()	Creates an Accumulation Distribution Line indicator on the scroller.
ama()	Creates AMA (Adaptive Moving Average) indicator on the scroller.
aroon()	Creates Aroon indicator on the scroller.
atr()	Creates an Average True Range indicator on the chart.
bbands()	Creates Bollinger Bands indicator on the scroller.
bbandsB()	Creates %B indicator on the scroller.
bbandsWidth()	Creates Bollinger Bands Width indicator on the scroller.
cci()	Creates a Commodity Channel Index indicator on the scroller.
cho()	Creates a Chaikin Oscillator indicator on the chart.
cmf()	Creates a Chaikin Money Flow indicator on the chart.
dmi()	Creates a Directional Movement Index indicator on the chart.
ema()	Creates EMA (Exponential Moving Average) indicator on the scroller.
kdj()	Creates a KDJ indicator on the scroller.
macd()	Creates MACD (Moving Average Convergence Divergence) indicator on the scroller.
mma()	Creates MMA (Modified Moving Average) indicator on the scroller.
roc()	Creates RoC (Rate of Change) indicator on the scroller.
rsi()	Creates RSI (Relative Strength Index) indicator on the scroller.
sma()	Creates SMA (Simple Moving Average) indicator on the scroller.
stochastic()	Creates a Stochastic indicator on the scroller.

Methods Description

addSeries

addSeries(var_args)Since version 7.8.0

Add series to chart.
Note: We recommend to use the line and area types for the scroller series.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Chart series data.

Returns:

Array.<anychart.core.stock.scrollerSeries.Base> - Array of created series.

Try it:

Usage sample

adl

adl(mapping, seriesType)Since version 7.14.0

Creates an Accumulation Distribution Line indicator on the scroller.

Params:

Name	Type	Description
mapping	anychart.data.TableMapping	Data mapping.
seriesType	anychart.enums.StockSeriesType	Series type.

Returns:

anychart.core.stock.indicators.ADL - An instance of the created series.

Try it:

Usage sample

allowRangeChange

allowRangeChange()Since version 7.8.0

Getter for mode of the range changing.

Returns:

boolean - The current mode of the range changing.

See listing

var scroller = chart.xScroller();
currentScroller.allowRangeChange();

allowRangeChange(value)Since version 7.8.0

Setter for mode of the range changing. If the range changing is allowed.

Params:

Name	Type	Default	Description
value	boolean	true	Value to set.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

ama

ama(mapping, period, fastPeriod, slowPeriod, seriesType)Since version 7.13.0

Creates AMA (Adaptive Moving Average) indicator on the scroller.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
period	number	20	Period.
fastPeriod	number	2	Fast period.
slowPeriod	number	30	Slow period.
seriesType	anychart.enums.StockSeriesType \| string	"line"	Series type for AMA indicator.

Returns:

anychart.core.stock.indicators.AMA - An instance of the created series.

Try it:

Usage sample

area

area(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Area series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.Area - An instance of the created series.

Try it:

Usage sample

aroon

aroon(mapping, period, upSeriesType, downSeriesType)Since version 7.12.0

Creates Aroon indicator on the scroller.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping
period	number	20	Period
upSeriesType	anychart.enums.StockSeriesType	"line"	Up Series type for the Aroon indicator.
downSeriesType	anychart.enums.StockSeriesType	"line"	Down Series type for the Aroon indicator.

Returns:

anychart.core.stock.indicators.Aroon - An instance of the created series.

Try it:

Usage sample

atr

atr(mapping, period, seriesType)Since version 7.13.0

Creates an Average True Range indicator on the chart.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
period	number	14	Moving average period value.
seriesType	anychart.enums.StockSeriesType	"line"	Series type for the Average True Range indicator.

Returns:

anychart.core.stock.indicators.ATR - An instance of the created series.

Try it:

Usage sample

autoHide

autoHide()Since version 7.8.0

Getter for scroller auto hide setting.

Returns:

boolean - The current value.

See listing

var currentScroller = chart.xScroller();
currentScroller.autoHide();

autoHide(value)Since version 7.8.0

Setter for scroller auto hide setting.

Detailed description

If the scroller should be automatically hidden if it cannot be changed (allowRangeChange(false)) and shows the full range (startRatio(0), endRatio(1)).

Params:

Name	Type	Default	Description
value	boolean	false	Value to set.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

bbands

bbands(mapping, period, deviation, upperSeriesType, lowerSeriesType, middleSeriesType)Since version 7.13.0

Creates Bollinger Bands indicator on the scroller.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
period	number	20	Moving average period value.
deviation	number	2	The multiplier applied to the moving average to compute upper and lower bands of the indicator.
upperSeriesType	anychart.enums.StockSeriesType \| string	"line"	Upper Series type for the Bollinger Bands indicator.
lowerSeriesType	anychart.enums.StockSeriesType \| string	"line"	Lower Series type for the Bollinger Bands indicator.
middleSeriesType	anychart.enums.StockSeriesType \| string	"line"	Middle Series type for the Bollinger Bands indicator.

Returns:

anychart.core.stock.indicators.BBands - An instance of the created series.

Try it:

Usage sample

bbandsB

bbandsB(mapping, period, deviation, seriesType)Since version 7.13.0

Creates %B indicator on the scroller.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
period	number	20	Moving average period value.
deviation	number	2	The multiplier applied to the moving average to compute upper and lower bands of the indicator.
seriesType	anychart.enums.StockSeriesType \| string	"line"	Series type for the %B indicator.

Returns:

anychart.core.stock.indicators.BBandsB - An instance of the created series.

Try it:

Usage sample

bbandsWidth

bbandsWidth(mapping, period, deviation, seriesType)Since version 7.13.0

Creates Bollinger Bands Width indicator on the scroller.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
period	number	20	Moving average period value.
deviation	number	2	The multiplier applied to the moving average to compute upper and lower bands of the indicator.
seriesType	anychart.enums.StockSeriesType \| string	"line"	Series type for the Bollinger Bands Width indicator.

Returns:

anychart.core.stock.indicators.BBandsWidth - An instance of the created series.

Try it:

Usage sample

candlestick

candlestick(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Candlestick series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.Candlestick - An instance of the created series.

Try it:

Usage sample

cci

cci(mapping, period, seriesType)Since version 7.14.0

Creates a Commodity Channel Index indicator on the scroller.

Params:

Name	Type	Description
mapping	anychart.data.TableMapping	Data mapping.
period	number	Moving average period value.
seriesType	anychart.enums.StockSeriesType	Series type.

Returns:

anychart.core.stock.indicators.CCI - An instance of the created series.

Try it:

Usage sample

cho

cho(mapping, fastPeriod, slowPeriod, maType, seriesType)Since version 7.14.0

Creates a Chaikin Oscillator indicator on the chart.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
fastPeriod	number	3	Indicator period.
slowPeriod	number	10	Indicator period.
maType	string	EMA	Indicator smoothing type.
seriesType	anychart.enums.StockSeriesType	"line"	Series type.

Returns:

anychart.core.stock.indicators.CHO - An instance of the created series.

Try it:

Usage sample

cmf

cmf(mapping, period, seriesType)Since version 7.14.0

Creates a Chaikin Money Flow indicator on the chart.

Params:

Name	Type	Description
mapping	anychart.data.TableMapping	Data mapping.
period	number	Moving average period value.
seriesType	anychart.enums.StockSeriesType	Series type.

Returns:

anychart.core.stock.indicators.CMF - An instance of the created series.

Try it:

Usage sample

column

column(data, mappingSettings, csvSettings)Since version 7.7.0

Creates and returns a new column series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.Column - An instance of the created series.

Try it:

defaultSeriesType

defaultSeriesType()Since version 7.8.0

Setter for the default stock scroller series type.
Note: We recommend to use the line and area types for the scroller series.

Returns:

string | anychart.enums.StockSeriesType - Default series type.

Try it:

Usage sample

defaultSeriesType(value)Since version 7.8.0

Setter for the stock scroller default series type.
Note: We recommend to use the line and area types for the scroller series.

Detailed description

Setting the default type using this method affects only series created using addSeries() method after the default is set. All series created prior to that do not change the type.

Params:

Name	Type	Description
value	string \| anychart.enums.StockSeriesType	Default series type.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

dmi

dmi(mapping, period, adxPeriod, useWildersSmoothing, pdiSeriesType, ndiSeriesType, adxSeriesType)Since version 7.14.0

Creates a Directional Movement Index indicator on the chart.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
period	number	14	Moving average period value.
adxPeriod	number	14	Period for ADX.
useWildersSmoothing	boolean	true	Wilders smoothing mode.
pdiSeriesType	anychart.enums.StockSeriesType	"line"	Type for +DI series.
ndiSeriesType	anychart.enums.StockSeriesType	"line"	Type for -DI series.
adxSeriesType	anychart.enums.StockSeriesType	"line"	Type for ADX series.

Returns:

anychart.core.stock.indicators.DMI - An instance of the created series.

Try it:

Usage sample

ema

ema(mapping, period, seriesType)Since version 7.9.0

Creates EMA (Exponential Moving Average) indicator on the scroller.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
period	number	20	Period.
seriesType	string \| anychart.enums.StockSeriesType	"line"	Series type for EMA indicator (type as "line", "column", "ohlc").

Returns:

anychart.core.stock.indicators.EMA - An instance of the created series.

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

fill

fill()Since version 7.7.0

Getter for current scroller fill.

Detailed description

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

Returns:

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

Try it:

Usage sample

fill(value)Since version 7.7.0

Sets scroller fill settings using an array or a string. Learn more about coloring.

Detailed description

Used to fill the background of selected part of the scroller.

Params:

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

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

fill(color, opacity)Since version 7.7.0

Scroller fill color with opacity.

Detailed description

Used to fill the background of selected part of the scroller. 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.Scroller - Self instance for method chaining.

Try it:

Usage sample

fill(keys, angle, mode, opacity)Since version 7.7.0

Linear gradient fill. Learn more about coloring.

Detailed description

Used to fill the background of selected part of the scroller.

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.Scroller - Self instance for method chaining.

Try it:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.7.0

Radial gradient fill. Learn more about coloring.

Detailed description

Used to fill the background of selected part of the scroller.

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.Scroller - Self instance for method chaining.

Try it:

Usage sample

fill(imageSettings)Since version 7.7.0

Image fill. Learn more about coloring.

Detailed description

Used to fill the background of selected part of the scroller.

Params:

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

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

getSeries

getSeries(id)Since version 7.7.0

Gets series by its id.

Params:

Name	Type	Description
id	number \| string	Id of the series.

Returns:

anychart.core.stock.scrollerSeries.Base - An instance of the created series.

Try it:

Usage sample

getSeriesAt

getSeriesAt(index)Since version 7.8.0

Gets the series by its index.

Params:

Name	Type	Description
index	number	Index of the series.

Returns:

anychart.core.stock.scrollerSeries.Base - An instance of the created series.

Try it:

Usage sample

getSeriesCount

getSeriesCount()Since version 7.8.0

Returns series count.

Returns:

number - Number of series.

Try it:

Usage sample

hatchFillPalette

hatchFillPalette()Since version 7.13.1

Getter for hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - Hatch fill palette settings.

See listing

var hatchFillPalette = scroller.hatchFillPalette();

hatchFillPalette(value)Since version 7.13.1

Hatch fill palette settings.

Params:

Name	Type	Description
value	Array.<anychart.graphics.vector.HatchFill.HatchFillType> \| Object \| anychart.palettes.HatchFills	Hatch fill palette settings to set.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

height

height()Since version 7.7.0

Getter for the current scroller height.

Returns:

number | string - The current scroller height.

Try it:

Usage sample

height(value)Since version 7.7.0

Setter for the scroller height.

Params:

Name	Type	Default	Description
value	number \| string	40	Scroller height

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

hilo

hilo(data, mappingSettings, csvSettings)Since version 7.14.0

Creates and returns a new HiLo series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.Hilo - An instance of the created series.

Try it:

Usage sample

jumpLine

jumpLine(data, mappingSettings, csvSettings)Since version 7.13.0

Creates and returns a new Jump Line series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.JumpLine - An instance of the created series.

Try it:

kdj

kdj(mapping, kPeriod, kMAPeriod, dPeriod, kMAType, dMAType, kMultiplier, dMultiplier, kSeriesType, dSeriesType, jSeriesType)Since version 7.13.0

Creates a KDJ indicator on the scroller.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
kPeriod	number	14	Indicator %K period.
kMAPeriod	number	5	Indicator %K smoothing period.
dPeriod	number	5	Indicator %D period.
kMAType	anychart.enums.MovingAverageType	"ema"	Indicator %K smoothing type.
dMAType	anychart.enums.MovingAverageType	"ema"	Indicator %D smoothing type.
kMultiplier	number	-2	The %K multiplier to calculate the % J values.
dMultiplier	number	3	The %D multiplier to calculate the % J values.
kSeriesType	anychart.enums.StockSeriesType	"line"	Series type for %K value.
dSeriesType	anychart.enums.StockSeriesType	"line"	Series type for %D value.
jSeriesType	anychart.enums.StockSeriesType	"line"	Series type for %J value.

Returns:

anychart.core.stock.indicators.KDJ - An instance of the created series.

Try it:

Usage sample

line

line(data, mappingSettings, csvSettings)Since version 7.7.0

Creates and returns a new line series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.Line - An instance of the created series.

Try it:

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

macd

macd(mapping, fastPeriod, slowPeriod, signalPeriod, macdSeriesType, signalSeriesType, histogramSeriesType)Since version 7.9.0

Creates MACD (Moving Average Convergence Divergence) indicator on the scroller.

Detailed description

MACD indicator shows the difference between fast and slow smoothing.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
fastPeriod	number	12	Fast period. Fast period must be greater than the slow period.
slowPeriod	number	26	Slow period.
signalPeriod	number	9	Signal period.
macdSeriesType	string \| anychart.enums.StockSeriesType	"line"	Series type for MACD indicator (type as "line", "column", "ohlc").
signalSeriesType	string \| anychart.enums.StockSeriesType	"line"	Series type for signal (type as "line", "column", "ohlc").
histogramSeriesType	string \| anychart.enums.StockSeriesType	"column"	Series type for histogram (type as "line", "column", "ohlc").

Returns:

anychart.core.stock.indicators.MACD - An instance of the created series.

Try it:

Usage sample

marker

marker(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Marker series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.Marker - An instance of the created series.

Try it:

Usage sample

maxHeight

maxHeight()Since version 7.7.0

Getter for the current scroller maximum height.

Returns:

number | string | null - The current scroller maximum height.

Try it:

Usage sample

maxHeight(value)Since version 7.7.0

Setter for the scroller maximum height.

Params:

Name	Type	Description
value	number \| string \| null	Maximum height

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

minHeight

minHeight()Since version 7.7.0

Setter for the current scroller minimum height.

Returns:

number | string | null - The current scroller minimum height.

Try it:

Usage sample

minHeight(value)Since version 7.7.0

Setter for the scroller minimum height.

Params:

Name	Type	Description
value	number \| string \| null	Minimum height.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

mma

mma(mapping, period, seriesType)Since version 7.13.0

Creates MMA (Modified Moving Average) indicator on the scroller.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
period	number	20	Period.
seriesType	anychart.enums.StockSeriesType \| string	"line"	Series type for MMA indicator.

Returns:

anychart.core.stock.indicators.MMA - An instance of the created series.

Try it:

Usage sample

ohlc

ohlc(data, mappingSettings, csvSettings)Since version 7.7.0

Creates and returns a new OHLC series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.OHLC - An instance of the created series.

Try it:

orientation

orientation()Since version 7.8.0

Getter for the current scroller orientation.

Returns:

anychart.enums.Orientation | string - Scroller orientation.

Try it:

Usage sample

orientation(value)Since version 7.8.0

Setter for the scroller orientation.

Params:

Name	Type	Default	Description
value	anychart.enums.Orientation \| string	"bottom"	Scroller orientation.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

outlineStroke

outlineStroke()Since version 7.7.0

Getter for the current outline stroke settings.

Returns:

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

Try it:

Usage sample

outlineStroke(value, thickness, dashpattern, lineJoin, lineCap)Since version 7.7.0

Setter for the outline stroke settings. Learn more about stroke settings.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null	"#cecece"	Stroke settings.
thickness	number		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.Scroller - Self instance for method chaining.

Try it:

Usage sample

palette

palette()Since version 7.13.1

Getter for the scroller colors palette.

Returns:

anychart.palettes.RangeColors | anychart.palettes.DistinctColors - Scroller colors palette.

Try it:

Usage sample

palette(value)Since version 7.13.1

Setter for the scroller colors palette.

Detailed description

Note: You can use predefined palettes from anychart.palettes.

Params:

Name	Type	Description
value	anychart.palettes.RangeColors \| anychart.palettes.DistinctColors \| Object \| Array.<string>	Colors palette settings to set.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

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

rangeArea

rangeArea(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Range Area series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.RangeArea - An instance of the created series.

Try it:

Usage sample

rangeColumn

rangeColumn(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Range Column series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.RangeColumn - An instance of the created series.

Try it:

Usage sample

rangeSplineArea

rangeSplineArea(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Range Spline Area series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.RangeSplineArea - An instance of the created series.

Try it:

Usage sample

rangeStepArea

rangeStepArea(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new rangeStepArea series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.RangeStepArea - An instance of the created series.

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

removeAllSeries

removeAllSeries()Since version 7.8.0

Removes all series from chart.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

removeSeries

removeSeries(id)Since version 7.8.0

Removes one of series from chart by its id.

Params:

Name	Type	Description
id	number \| string	Series id.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

removeSeriesAt

removeSeriesAt(index)Since version 7.8.0

Removes one of series from chart by its index.

Params:

Name	Type	Description
index	number	Series index.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

roc

roc(mapping, period, seriesType)Since version 7.9.0

Creates RoC (Rate of Change) indicator on the scroller.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
period	number	20	Period.
seriesType	string \| anychart.enums.StockSeriesType	"line"	Series type for Roc indicator (type as "line", "column", "ohlc").

Returns:

anychart.core.stock.indicators.RoC - An instance of the created series.

Try it:

Usage sample

rsi

rsi(mapping, period, seriesType)Since version 7.9.0

Creates RSI (Relative Strength Index) indicator on the scroller.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
period	number	14	Period.
seriesType	string \| anychart.enums.StockSeriesType	"line"	Series type for RSI indicator (type as "line", "column", "ohlc").

Returns:

anychart.core.stock.indicators.RSI - An instance of the created series.

Try it:

Usage sample

selectedFill

selectedFill()Since version 7.7.0

Getter for current scroller fill 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 current fill color.

Try it:

Usage sample

selectedFill(value)Since version 7.7.0

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

Detailed description

Used to fill the background of selected part of the scroller.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	{color: "#1976d2", opacity: 0.2}	Color as an array or a string.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

selectedFill(color, opacity)Since version 7.7.0

Scroller fill color in selected mode with opacity.

Detailed description

Params:

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

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

selectedFill(keys, angle, mode, opacity)Since version 7.7.0

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

Detailed description

Used to fill the background of selected part of the scroller.

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.Scroller - Self instance for method chaining.

Try it:

Usage sample

selectedFill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.7.0

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

Detailed description

Used to fill the background of selected part of the scroller.

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.Scroller - Self instance for method chaining.

Try it:

Usage sample

selectedFill(imageSettings)Since version 7.7.0

Image fill in selected mode. Learn more about coloring.

Detailed description

Used to fill the background of selected part of the scroller.

Params:

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

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

Usage sample

sma

sma(mapping, period, seriesType)Since version 7.9.0

Creates SMA (Simple Moving Average) indicator on the scroller.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
period	number	20	Period.
seriesType	string \| anychart.enums.StockSeriesType	"line"	Series type for SMA indicator (type as "line", "column", "ohlc").

Returns:

anychart.core.stock.indicators.SMA - An instance of the created series.

Try it:

Usage sample

spline

spline(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Spline series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.Spline - An instance of the created series.

Try it:

Usage sample

splineArea

splineArea(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Spline Area series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.SplineArea - An instance of the created series.

Try it:

Usage sample

stepArea

stepArea(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Step Area series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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 - An instance of the created series.

Try it:

Usage sample

stepLine

stepLine(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Step Line series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.StepLine - An instance of the created series.

Try it:

Usage sample

stick

stick(data, mappingSettings, csvSettings)Since version 7.13.0

Creates and returns a new Stick series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}\|number)>	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.Stick - An instance of the created series.

Try it:

stochastic

stochastic(mapping, kPeriod, kMAPeriod, dPeriod, kMAType, dMAType, kSeriesType, dSeriesType)Since version 7.13.0

Creates a Stochastic indicator on the scroller.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
kPeriod	number	14	Moving average period value for %K.
kMAPeriod	number	1	Indicator %K smoothing period.
dPeriod	number	3	Moving average period value for %D.
kMAType	anychart.enums.MovingAverageType	"sma"	Indicator %K smoothing type.
dMAType	anychart.enums.MovingAverageType	"sma"	Indicator %D smoothing type.
kSeriesType	anychart.enums.StockSeriesType	"line"	Series type for %K value.
dSeriesType	anychart.enums.StockSeriesType	"line"	Series type for %D value.

Returns:

anychart.core.stock.indicators.Stochastic - An instance of the created series.

Try it:

Usage sample

thumbs

thumbs()Since version 7.7.0

Getter for the current thumbs.

Returns:

anychart.core.ui.Scroller.Thumbs - Thumbs instance.

Try it:

Usage sample

thumbs(value)Since version 7.7.0

Setter for the thumbs settings.

Detailed description

Sets thumbs settings depending on parameter type:

null/boolean - disable or enable thumbs.
object - sets thumbs settings.

Params:

Name	Type	Default	Description
value	boolean \| Object \| null	null	Thumbs settings.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

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

xAxis

xAxis()Since version 7.7.0

Getter for the current scroller X-axis.

Returns:

anychart.core.axes.StockDateTime - Axis instance.

Try it:

Usage sample

xAxis(value)Since version 7.7.0

Setter for the scroller X-axis.

Detailed description

Sets scroller Y-axis settings depending on parameter type:

null/boolean - disable or enable scroller Y-axis.
object - sets scroller Y-axis settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Chart axis settings to set.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.

Try it:

yScale

yScale()Since version 7.7.0

Getter for the current scroller Y-scale.

Returns:

anychart.scales.ScatterBase - Default chart scale value.

See listing

var myScroller = chart.scroller();
myScroller.yScale();

yScale(value)Since version 7.7.0

Setter for the scroller Y-scale.

Params:

Name	Type	Description
value	anychart.enums.ScatterScaleTypes \| anychart.scales.ScatterBase	Y-scale to set.

Returns:

anychart.core.stock.Scroller - 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.Scroller - Self instance for method chaining.

Try it:

Usage sample