AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.stock.Scroller Improve this Doc

Extends: anychart.core.ui.Scroller

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()Select 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.
inverted()Inverted settings.
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.
ao()Creates an Awesome Oscillator indicator on the scroller.
aroon()Creates Aroon indicator on the scroller.
atr()Creates an Average True Range indicator on the scroller.
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 scroller.
cmf()Creates a Chaikin Money Flow indicator on the scroller.
dmi()Creates a Directional Movement Index indicator on the scroller.
ema()Creates EMA (Exponential Moving Average) indicator on the scroller.
ha()Creates a Heikin-Ashi indicator on the scroller.
kdj()Creates a KDJ indicator on the scroller.
keltnerChannels()Creates a Keltner Channels indicator on the scroller.
macd()Creates MACD (Moving Average Convergence Divergence) indicator on the scroller.
mfi()Creates a MFI (Money Flow Index) indicator on the scroller.
mma()Creates MMA (Modified Moving Average) indicator on the scroller.
momentum()Creates a Momentum indicator on the scroller.
obv()Creates an On Balance Volume indicator on the scroller.
priceChannels()Creates a Price Channels indicator on the scroller.
psar()Creates a PSAR (Parabolic SAR) 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.
trix()Creates a TRIX indicator on the scroller.
volumeMa()Creates a Volume + MA indicator on the scroller.
williamsR()Creates a Williams %R indicator on the scroller.

Methods Description

addSeries

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

Params:

NameTypeDescription
var_argsanychart.data.View | anychart.data.Set | ArrayChart series data.

Returns:

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

adl

Creates an Accumulation Distribution Line indicator on the scroller.

Params:

NameTypeDescription
mappinganychart.data.TableMappingData mapping.
seriesTypeanychart.enums.StockSeriesType | stringSeries type.

Returns:

anychart.core.stock.indicators.ADL - Returns an Accumulation Distribution Line indicator.

allowRangeChange

Getter for the mode of the range changing.

Returns:

boolean - Mode of the range changing.
See listing
var scroller = chart.xScroller();
var allowRangeChange = scroller.allowRangeChange();
Setter for the mode of the range changing. If the range changing is allowed.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

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

ama

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

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Period.
fastPeriodnumber
2
Fast period.
slowPeriodnumber
30
Slow period.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for AMA indicator.

Returns:

anychart.core.stock.indicators.AMA - Returns AMA (Adaptive Moving Average) indicator.

ao

Creates an Awesome Oscillator indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
fastPeriodnumber
5
Indicator fast period.
slowPeriodnumber
34
Indicator slow period.
maTypeanychart.enums.MovingAverageType | string
'sma'
Indicator smoothing type.
seriesTypeanychart.enums.StockSeriesType | string
'line'
Series type.

Returns:

anychart.core.stock.indicators.AO - Returns Awesome Oscillator indicator.

area

Creates and returns a new Area series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

aroon

Creates Aroon indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping
periodnumber
20
Period
upSeriesTypeanychart.enums.StockSeriesType | string
"line"
Up Series type for the Aroon indicator.
downSeriesTypeanychart.enums.StockSeriesType | string
"line"
Down Series type for the Aroon indicator.

Returns:

anychart.core.stock.indicators.Aroon - Returns Aroon indicator.

atr

Creates an Average True Range indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
14
Moving average period value.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for the Average True Range indicator.

Returns:

anychart.core.stock.indicators.ATR - Returns an Average True Range indicator.

autoHide

Getter for scroller auto hide mode.

Returns:

boolean - Auto hide mode.
See listing
var scroller = chart.xScroller();
var state = scroller.autoHide();
Setter for scroller auto hide mode.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enabled state to set.

Returns:

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

bbands

Creates Bollinger Bands indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Moving average period value.
deviationnumber
2
The multiplier applied to the moving average to compute upper and lower bands of the indicator.
middleSeriesTypeanychart.enums.StockSeriesType | string
"line"
Middle Series type for the Bollinger Bands indicator.
upperSeriesTypeanychart.enums.StockSeriesType | string
"line"
Upper Series type for the Bollinger Bands indicator.
lowerSeriesTypeanychart.enums.StockSeriesType | string
"line"
Lower Series type for the Bollinger Bands indicator.

Returns:

anychart.core.stock.indicators.BBands - Returns Bollinger Bands indicator.

bbandsB

Creates %B indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Moving average period value.
deviationnumber
2
The multiplier applied to the moving average to compute upper and lower bands of the indicator.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for the %B indicator.

Returns:

anychart.core.stock.indicators.BBandsB - Returns %B indicator.

bbandsWidth

Creates Bollinger Bands Width indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Moving average period value.
deviationnumber
2
The multiplier applied to the moving average to compute upper and lower bands of the indicator.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for the Bollinger Bands Width indicator.

Returns:

anychart.core.stock.indicators.BBandsWidth - Returns Bollinger Bands Width indicator.

candlestick

Creates and returns a new Candlestick series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

cci

Creates a Commodity Channel Index indicator on the scroller.

Params:

NameTypeDescription
mappinganychart.data.TableMappingData mapping.
periodnumberMoving average period value.
seriesTypeanychart.enums.StockSeriesType | stringSeries type.

Returns:

anychart.core.stock.indicators.CCI - Returns a Commodity Channel Index indicator.

cho

Creates a Chaikin Oscillator indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
fastPeriodnumber
3
Indicator period.
slowPeriodnumber
10
Indicator period.
maTypestring
EMA
Indicator smoothing type.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type.

Returns:

anychart.core.stock.indicators.CHO - Returns a Chaikin Oscillator indicator.

cmf

Creates a Chaikin Money Flow indicator on the scroller.

Params:

NameTypeDescription
mappinganychart.data.TableMappingData mapping.
periodnumberMoving average period value.
seriesTypeanychart.enums.StockSeriesType | stringSeries type.

Returns:

anychart.core.stock.indicators.CMF - Returns a Chaikin Money Flow indicator.

column

Creates and returns a new column series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringData to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

defaultSeriesType

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

Returns:

anychart.enums.StockSeriesType | string - Default series type.
Setter for the stock scroller default series type.
Note: We recommend to use the line and area types for the scroller series.

Params:

NameTypeDescription
typeanychart.enums.StockSeriesType | stringDefault series type.

Returns:

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

dmi

Creates a Directional Movement Index indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
14
Moving average period value.
adxPeriodnumber
14
Period for ADX.
useWildersSmoothingboolean
true
Wilders smoothing mode.
pdiSeriesTypeanychart.enums.StockSeriesType | string
"line"
Type for +DI series.
ndiSeriesTypeanychart.enums.StockSeriesType | string
"line"
Type for -DI series.
adxSeriesTypeanychart.enums.StockSeriesType | string
"line"
Type for ADX series.

Returns:

anychart.core.stock.indicators.DMI - Returns a Directional Movement Index indicator.

ema

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

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Period.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for EMA indicator (type as "line", "column", "ohlc").

Returns:

anychart.core.stock.indicators.EMA - Returns EMA (Exponential Moving Average) indicator.

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

fill

Getter for the scroller fill.

Returns:

anychart.graphics.vector.Fill - Fill color.
Setter for scroller fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
'#fff'
Color as an array, an object or a string.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.
Scroller fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.
Image fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

getSeries

Gets series by its id.

Params:

NameTypeDescription
idnumber | stringId of the series.

Returns:

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

getSeriesAt

Gets the series by its index.

Params:

NameTypeDescription
indexnumberIndex of the series.

Returns:

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

getSeriesCount

Returns series count.

Returns:

number - Number of series.

ha

Creates a Heikin-Ashi indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
seriesTypeanychart.enums.StockSeriesType | string
'candlestick'
Series type.

Returns:

anychart.core.stock.indicators.HA - Returns Heikin-Ashi indicator.

hatchFillPalette

Getter for hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - Hatch fill palette settings.
See listing
var hatchFillPalette = scroller.hatchFillPalette();
Hatch fill palette settings.

Params:

NameTypeDescription
valueArray.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFillsHatch fill palette settings to set.

Returns:

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

height

Getter for the scroller height.

Returns:

number | string - Scroller height.
Setter for the scroller height.

Params:

NameTypeDefaultDescription
heightnumber | string
40
Scroller height to set.

Returns:

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

hilo

Creates and returns a new HiLo series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

inverted

Getter for the scroller inversion.

Returns:

boolean - Inverted state.
Setter for the scroller inversion.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether scroller should be inverted or not.

Returns:

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

jumpLine

Creates and returns a new Jump Line series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

kdj

Creates a KDJ indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
kPeriodnumber
14
Indicator %K period.
kMAPeriodnumber
5
Indicator %K smoothing period.
dPeriodnumber
5
Indicator %D period.
kMATypeanychart.enums.MovingAverageType | string
"ema"
Indicator %K smoothing type.
dMATypeanychart.enums.MovingAverageType | string
"ema"
Indicator %D smoothing type.
kMultipliernumber
-2
The %K multiplier to calculate the % J values.
dMultipliernumber
3
The %D multiplier to calculate the % J values.
kSeriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for %K value.
dSeriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for %D value.
jSeriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for %J value.

Returns:

anychart.core.stock.indicators.KDJ - Returns a KDJ indicator.

keltnerChannels

Creates a Keltner Channels indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
maPeriodnumber
20
Moving Average period.
atrPeriodnumber
10
Average True Range period.
maTypeanychart.enums.MovingAverageType | string
'ema'
Indicator Moving Average type.
multipliernumber
2
Multiplier.
maSeriesanychart.enums.StockSeriesType | string
'line'
Moving Average series type.

Returns:

anychart.core.stock.indicators.KeltnerChannels - Returns Keltner Channels indicator.

line

Creates and returns a new line series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringData to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

macd

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

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
fastPeriodnumber
12
Fast period. Fast period must be greater than the slow period.
slowPeriodnumber
26
Slow period.
signalPeriodnumber
9
Signal period.
macdSeriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for MACD indicator (type as "line", "column", "ohlc").
signalSeriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for signal (type as "line", "column", "ohlc").
histogramSeriesTypeanychart.enums.StockSeriesType | string
"column"
Series type for histogram (type as "line", "column", "ohlc").

Returns:

anychart.core.stock.indicators.MACD - Returns MACD (Moving Average Convergence Divergence) indicator.

marker

Creates and returns a new Marker series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

maxHeight

Getter for the scroller maximum height.

Returns:

number | string | null - Scroller maximum height.
Setter for the scroller maximum height.

Params:

NameTypeDescription
heightnumber | string | nullMaximum height

Returns:

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

mfi

Creates a MFI (Money Flow Index) indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
10
Period.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for MFI indicator.

Returns:

anychart.core.stock.indicators.MFI - Returns a MFI (Money Flow Index) indicator.

minHeight

Setter for the scroller minimum height.

Returns:

number | string | null - Scroller minimum height.
Setter for the scroller minimum height.

Params:

NameTypeDescription
heightnumber | string | nullMinimum height.

Returns:

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

mma

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

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Period.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for MMA indicator.

Returns:

anychart.core.stock.indicators.MMA - Returns MMA (Modified Moving Average) indicator.

momentum

Creates a Momentum indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
14
Period.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for Momentum indicator.

Returns:

anychart.core.stock.indicators.Momentum - Returns a Momentum indicator.

obv

Creates an On Balance Volume indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
seriesTypeanychart.enums.StockSeriesType | string
'line'
Series type.

Returns:

anychart.core.stock.indicators.OBV - Returns On Balance Volume indicator.

ohlc

Creates and returns a new OHLC series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringData to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

orientation

Getter for the scroller orientation.

Returns:

anychart.enums.Orientation | string - Scroller orientation.
Setter for the scroller orientation.

Params:

NameTypeDefaultDescription
orientationanychart.enums.Orientation | string
'bottom'
Scroller orientation.

Returns:

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

outlineStroke

Getter for outline stroke settings.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
Setter for outline stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
'#cecece'
Stroke settings.
thicknessnumber
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.
Setter for outline stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

palette

Getter for the scroller colors palette.
Setter for the scroller colors palette.

Params:

NameTypeDescription
valueanychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string>Colors palette settings to set.

Returns:

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

priceChannels

Creates a Price Channels indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Period.
middleSeriesTypeanychart.enums.StockSeriesType | string
"line"
Middle Series type for the Price Channels indicator.
rangeSeriesTypeanychart.enums.StockSeriesType | string
"range-area"
Range Series type for the Price Channels indicator.

Returns:

anychart.core.stock.indicators.PriceChannels - Returns a Price Channels indicator.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

psar

Creates a PSAR (Parabolic SAR) indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
accelerationFactorStartnumber
0.02
Start acceleration factor.
accelerationFactorIncrementnumber
0.02
Increment acceleration factor.
accelerationFactorMaximumnumber
0.2
Maximum acceleration factor value.
seriesTypeanychart.enums.StockSeriesType | string
"marker"
Series type for PSAR indicator.

Returns:

anychart.core.stock.indicators.PSAR - Returns a PSAR (Parabolic SAR) indicator.

rangeArea

Creates and returns a new Range Area series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

rangeColumn

Creates and returns a new Range Column series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

rangeSplineArea

Creates and returns a new Range Spline Area series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

rangeStepArea

Creates and returns a new rangeStepArea series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

removeAllListeners

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

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

removeAllSeries

Removes all series from chart.

Returns:

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

removeSeries

Removes one of series from chart by its id.

Params:

NameTypeDescription
idnumber | stringSeries id.

Returns:

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

removeSeriesAt

Removes one of series from chart by its index.

Params:

NameTypeDescription
indexnumberSeries index.

Returns:

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

roc

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

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Period.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for Roc indicator (type as "line", "column", "ohlc").

Returns:

anychart.core.stock.indicators.RoC - Returns RoC (Rate of Change) indicator.

rsi

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

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
14
Period.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for RSI indicator (type as "line", "column", "ohlc").

Returns:

anychart.core.stock.indicators.RSI - Returns RSI (Relative Strength Index) indicator.

selectedFill

Getter for scroller fill in selected mode.

Returns:

anychart.graphics.vector.Fill - Select fill color.
Setter for scroller fill settings in selected mode using an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
{color: "#1976d2", opacity: 0.2}
Color as an array, an object or a string.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.
Scroller fill color in selected mode with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.
Linear gradient fill in selected mode. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.
Radial gradient fill in selected mode. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.stock.Scroller - Self instance for method chaining.
Image fill in selected mode. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

sma

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

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Period.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for SMA indicator (type as "line", "column", "ohlc").

Returns:

anychart.core.stock.indicators.SMA - Returns SMA (Simple Moving Average) indicator.

spline

Creates and returns a new Spline series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

splineArea

Creates and returns a new Spline Area series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

stepArea

Creates and returns a new Step Area series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

stepLine

Creates and returns a new Step Line series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

stick

Creates and returns a new Stick series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: (anychart.enums.AggregationType|string), 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|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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

stochastic

Creates a Stochastic indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
kPeriodnumber
14
Moving average period value for %K.
kMAPeriodnumber
1
Indicator %K smoothing period.
dPeriodnumber
3
Moving average period value for %D.
kMATypeanychart.enums.MovingAverageType | string
"sma"
Indicator %K smoothing type.
dMATypeanychart.enums.MovingAverageType | string
"sma"
Indicator %D smoothing type.
kSeriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for %K value.
dSeriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for %D value.

Returns:

anychart.core.stock.indicators.Stochastic - Returns a Stochastic indicator.

thumbs

Getter for the thumbs.

Returns:

anychart.core.ui.Scroller.Thumbs - Thumbs instance.
Setter for the thumbs settings.

Params:

NameTypeDefaultDescription
settingsboolean | Object | null
null
Thumbs settings.

Returns:

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

trix

Creates a TRIX indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
15
Indicator TRIX period.
signalPeriodnumber
9
Indicator signal period.
maTypeanychart.enums.MovingAverageType | string
'ema'
Indicator smoothing type.
signalMaTypeanychart.enums.MovingAverageType | string
'ema'
Indicator signal smoothing type.
trixSeriesTypeanychart.enums.StockSeriesType | string
'line'
TRIX series type.
signalSeriesTypeanychart.enums.StockSeriesType | string
'line'
Signal series type.

Returns:

anychart.core.stock.indicators.TRIX - Returns TRIX indicator.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

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

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

volumeMa

Creates a Volume + MA indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
maPeriodnumber
20
Moving Average period.
maTypeanychart.enums.MovingAverageType | string
'sma'
Indicator smoothing type.
volumeSeriesTypeanychart.enums.StockSeriesType | string
'stick'
Volume series type.
maSeriesTypeanychart.enums.StockSeriesType | string
'line'
Moving Average series type.

Returns:

anychart.core.stock.indicators.VolumeMA - Returns Volume + MA indicator.

williamsR

Creates a Williams %R indicator on the scroller.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
10
Period.
seriesTypeanychart.enums.StockSeriesType | string
"line"
Series type for Williams %R indicator.

Returns:

anychart.core.stock.indicators.WilliamsR - Returns a Williams %R indicator.

xAxis

Getter for the scroller X-axis.

Returns:

anychart.core.axes.StockDateTime - Axis instance.
Setter for the scroller X-axis.

Params:

NameTypeDescription
settingsObject | boolean | nullChart axis settings to set.

Returns:

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

yScale

Getter for the scroller Y-scale.

Returns:

anychart.scales.ScatterBase - Default chart scale value.
See listing
var scroller = chart.scroller();
var yScale = scroller.yScale();
Setter for the scroller Y-scale.

Params:

NameTypeDefaultDescription
settingsanychart.enums.ScatterScaleTypes | string | anychart.scales.ScatterBase | Object
anychart.scales.Linear
Scale settings to set.

Returns:

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

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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