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. |
| 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. |
| aroonOscillator() | Creates Aroon Oscillator 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. |
| coppockCurve() | Creates a Coppock Curve indicator on the scroller. |
| dmi() | Creates a Directional Movement Index indicator on the scroller. |
| ema() | Creates EMA (Exponential Moving Average) indicator on the scroller. |
| env() | Creates ENV (Envelope) indicator on the scroller. |
| ha() | Creates a Heikin-Ashi indicator on the scroller. |
| ikh() | Creates an Ichimoku Cloud (IKH) 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. |
| ppo() | Creates PPO (Price Oscillator) indicator on the scroller. |
| priceChannels() | Creates a Price Channels indicator on the scroller. |
| psar() | Creates a PSAR (Parabolic SAR) indicator on the scroller. |
| psy() | Creates a PSY (The Psychological Line) indicator on the scroller. |
| rat() | Creates RAT (Ratiocator) indicator on the scroller. |
| rci() | Creates a RCI (Rank Correlation Index) indicator on the plot. |
| 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. |
| vwap() | Creates a Volume Weighted Average Price (VWAP) indicator on the scroller. |
| williamsR() | Creates a Williams %R indicator on the scroller. |
| wma() | Creates WMA (Weighted Moving Average) 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.
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:
adl
Creates an Accumulation Distribution Line indicator on the scroller.
Params:
| Name | Type | Description |
|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. |
| seriesType | anychart.enums.StockSeriesType | string | Series type. |
Returns:
anychart.core.stock.indicators.ADL - Returns an Accumulation Distribution Line indicator.Try it:
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:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it:
ama
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 - Returns AMA (Adaptive Moving Average) indicator.Try it:
ao
Creates an Awesome Oscillator indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| fastPeriod | number | 5 | Indicator fast period. |
| slowPeriod | number | 34 | Indicator slow period. |
| maType | anychart.enums.MovingAverageType | string | 'sma' | Indicator smoothing type. |
| seriesType | anychart.enums.StockSeriesType | string | 'line' | Series type. |
Returns:
anychart.core.stock.indicators.AO - Returns Awesome Oscillator indicator.Try it:
area
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|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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.Area - An instance of the created series.Try it:
aroon
Creates Aroon indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping | |
| period | number | 25 | Period |
| upSeriesType | anychart.enums.StockSeriesType | string | "line" | Up Series type for the Aroon indicator. |
| downSeriesType | anychart.enums.StockSeriesType | string | "line" | Down Series type for the Aroon indicator. |
Returns:
anychart.core.stock.indicators.Aroon - Returns Aroon indicator.Try it:
aroonOscillator
Creates Aroon Oscillator indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping | |
| period | number | 25 | Period |
| seriesType | anychart.enums.StockSeriesType | string | "area" | Series type for the Aroon Oscillator indicator. |
Returns:
anychart.core.stock.indicators.AroonOscillator - Returns Aroon Oscillator indicator.Try it:
atr
Creates an Average True Range indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| period | number | 14 | Moving average period value. |
| seriesType | anychart.enums.StockSeriesType | string | "line" | Series type for the Average True Range indicator. |
Returns:
anychart.core.stock.indicators.ATR - Returns an Average True Range indicator.Try it:
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.
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 |
|---|---|---|---|
| enabled | boolean | false | Enabled state to set. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it:
bbands
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. |
| middleSeriesType | anychart.enums.StockSeriesType | string | "line" | Middle Series type for the Bollinger Bands 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. |
Returns:
anychart.core.stock.indicators.BBands - Returns Bollinger Bands indicator.Try it:
bbandsB
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 - Returns %B indicator.Try it:
bbandsWidth
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 - Returns Bollinger Bands Width indicator.Try it:
candlestick
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|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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.Candlestick - An instance of the created series.Try it:
cci
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 | string | Series type. |
Returns:
anychart.core.stock.indicators.CCI - Returns a Commodity Channel Index indicator.Try it:
cho
Creates a Chaikin Oscillator indicator on the scroller.
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 | string | "line" | Series type. |
Returns:
anychart.core.stock.indicators.CHO - Returns a Chaikin Oscillator indicator.Try it:
cmf
Creates a Chaikin Money Flow indicator on the scroller.
Params:
| Name | Type | Description |
|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. |
| period | number | Moving average period value. |
| seriesType | anychart.enums.StockSeriesType | string | Series type. |
Returns:
anychart.core.stock.indicators.CMF - Returns a Chaikin Money Flow indicator.Try it:
column
Creates and returns a new column series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string | Data to set. |
| mappingSettings | Object.<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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.Column - An instance of the created series.Try it:
coppockCurve
Creates a Coppock Curve indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| wmaPeriod | number | 10 | WMA calculation period. |
| firstRocPeriod | number | 11 | The first RoC calculation period. |
| secondRocPeriod | number | 14 | The second RoC calculation period. |
| seriesType | anychart.enums.StockSeriesType | string | Series type. |
Returns:
anychart.core.stock.indicators.CoppockCurve - Returns a Coppock Curve indicator.Try it:
defaultSeriesType
Setter for the default stock scroller series type.
Note: We recommend to use the line and area types for the scroller series.
Note: We recommend to use the line and area types for the scroller series.
Returns:
anychart.enums.StockSeriesType | string - Default series type.Try it:
Setter for the stock scroller default series type.
Note: We recommend to use the line and area types for the scroller series.
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 |
|---|---|---|
| type | anychart.enums.StockSeriesType | string | Default series type. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it:
dmi
Creates a Directional Movement Index indicator on the scroller.
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 | string | "line" | Type for +DI series. |
| ndiSeriesType | anychart.enums.StockSeriesType | string | "line" | Type for -DI series. |
| adxSeriesType | anychart.enums.StockSeriesType | string | "line" | Type for ADX series. |
Returns:
anychart.core.stock.indicators.DMI - Returns a Directional Movement Index indicator.Try it:
ema
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 | anychart.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.Try it:
enabled
Getter for the element state (enabled or disabled).
Returns:
boolean - Element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
env
Creates ENV (Envelope) indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| period | number | 20 | Period. |
| deviation | number | 10 | Deviation. |
| maType | anychart.enums.MovingAverageType | string | "ema" | Indicator smoothing type. |
| upperSeriesType | anychart.enums.StockSeriesType | string | "line" | Series type. |
| lowerSeriesType | anychart.enums.StockSeriesType | string | "line" | Series type. |
Returns:
anychart.core.stock.indicators.ENV - Returns ENV (Envelope) indicator.Try it:
fill
Getter for the scroller fill.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.Fill - Fill color.Try it:
Setter for scroller fill settings using an array, an object 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 |
|---|---|---|---|
| color | anychart.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.
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:
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:
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:
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:
getSeries
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:
getSeriesAt
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:
getSeriesCount
ha
Creates a Heikin-Ashi indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| seriesType | anychart.enums.StockSeriesType | string | 'candlestick' | Series type. |
Returns:
anychart.core.stock.indicators.HA - Returns Heikin-Ashi indicator.Try it:
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:
| 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:
height
Setter for the scroller height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | 40 | Scroller height to set. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it:
hilo
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|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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.Hilo - An instance of the created series.Try it:
ikh
Creates an Ichimoku Cloud (IKH) indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| conversionPeriod | number | 9 | Indicator conversion line period. |
| basePeriod | number | 26 | Indicator Base line period. |
| leadingPeriod | number | 52 | Indicator Leading span period. Also used to move the Cloud forward.. |
| conversionSeriesType | anychart.enums.StockSeriesType | string | "line" | Conversion series type. |
| baseSeriesType | anychart.enums.StockSeriesType | string | "line" | Base series type. |
| leadingSeriesType | anychart.enums.StockSeriesType | string | "range-area" | Leading span series type. |
| laggingSeriesType | anychart.enums.StockSeriesType | string | "line" | Lagging series type. |
Returns:
anychart.core.stock.indicators.IKH - Returns an Ichimoku Cloud (IKH) indicator.Try it:
inverted
Getter for the scroller inversion.
Returns:
boolean - Inverted state.Setter for the scroller inversion.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Whether scroller should be inverted or not. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it:
jumpLine
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|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'. |
| 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
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 | string | "ema" | Indicator %K smoothing type. |
| dMAType | anychart.enums.MovingAverageType | string | "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 | string | "line" | Series type for %K value. |
| dSeriesType | anychart.enums.StockSeriesType | string | "line" | Series type for %D value. |
| jSeriesType | anychart.enums.StockSeriesType | string | "line" | Series type for %J value. |
Returns:
anychart.core.stock.indicators.KDJ - Returns a KDJ indicator.Try it:
keltnerChannels
Creates a Keltner Channels indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| maPeriod | number | 20 | Moving Average period. |
| atrPeriod | number | 10 | Average True Range period. |
| maType | anychart.enums.MovingAverageType | string | 'ema' | Indicator Moving Average type. |
| multiplier | number | 2 | Multiplier. |
| maSeries | anychart.enums.StockSeriesType | string | 'line' | Moving Average series type. |
Returns:
anychart.core.stock.indicators.KeltnerChannels - Returns Keltner Channels indicator.Try it:
line
Creates and returns a new line series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string | Data to set. |
| mappingSettings | Object.<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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.Line - An instance of the created series.Try it:
macd
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 | anychart.enums.StockSeriesType | string | "line" | Series type for MACD indicator (type as "line", "column", "ohlc"). |
| signalSeriesType | anychart.enums.StockSeriesType | string | "line" | Series type for signal (type as "line", "column", "ohlc"). |
| histogramSeriesType | anychart.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.Try it:
marker
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|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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.Marker - An instance of the created series.Try it:
maxHeight
Getter for the scroller maximum height.
Returns:
number | string | null - Scroller maximum height.Try it:
Setter for the scroller maximum height.
Params:
| Name | Type | Description |
|---|---|---|
| height | number | string | null | Maximum height |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it:
mfi
Creates a MFI (Money Flow Index) indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| period | number | 10 | Period. |
| seriesType | anychart.enums.StockSeriesType | string | "line" | Series type for MFI indicator. |
Returns:
anychart.core.stock.indicators.MFI - Returns a MFI (Money Flow Index) indicator.Try it:
minHeight
Setter for the scroller minimum height.
Returns:
number | string | null - Scroller minimum height.Try it:
Setter for the scroller minimum height.
Params:
| Name | Type | Description |
|---|---|---|
| height | number | string | null | Minimum height. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it:
mma
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 - Returns MMA (Modified Moving Average) indicator.Try it:
momentum
Creates a Momentum indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| period | number | 14 | Period. |
| seriesType | anychart.enums.StockSeriesType | string | "line" | Series type for Momentum indicator. |
Returns:
anychart.core.stock.indicators.Momentum - Returns a Momentum indicator.Try it:
obv
Creates an On Balance Volume indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| seriesType | anychart.enums.StockSeriesType | string | 'line' | Series type. |
Returns:
anychart.core.stock.indicators.OBV - Returns On Balance Volume indicator.Try it:
ohlc
Creates and returns a new OHLC series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string | Data to set. |
| mappingSettings | Object.<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'. |
| 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
Getter for the scroller orientation.
Returns:
anychart.enums.Orientation | string - Scroller orientation.Try it:
Setter for the scroller orientation.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| orientation | anychart.enums.Orientation | string | 'bottom' | Scroller orientation. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it:
outlineStroke
Getter for outline stroke settings.
Returns:
anychart.graphics.vector.Stroke - Stroke settings.Try it:
Setter for outline stroke settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | 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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it:
Setter for outline stroke using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it:
palette
Getter for the scroller colors palette.
Try it:
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.ppo
Creates PPO (Price Oscillator) indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| shortPeriod | number | 12 | Indicator short period. |
| longPeriod | number | 26 | Indicator long period. |
| smoothingPeriod | number | 9 | Indicator smoothing period. |
| ppoSeriesType | anychart.enums.StockSeriesType | string | "line" | PPO line series type. |
| signalSeriesType | anychart.enums.StockSeriesType | string | "line" | Signal line series type. |
| histogramSeriesType | anychart.enums.StockSeriesType | string | "column" | PPO Histogram series type. |
Returns:
anychart.core.stock.indicators.PPO - Returns Price Oscillator indicator.Try it:
priceChannels
Creates a Price Channels indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| period | number | 20 | Period. |
| middleSeriesType | anychart.enums.StockSeriesType | string | "line" | Middle Series type for the Price Channels indicator. |
| rangeSeriesType | anychart.enums.StockSeriesType | string | "range-area" | Range Series type for the Price Channels indicator. |
Returns:
anychart.core.stock.indicators.PriceChannels - Returns a Price Channels indicator.psar
Creates a PSAR (Parabolic SAR) indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| accelerationFactorStart | number | 0.02 | Start acceleration factor. |
| accelerationFactorIncrement | number | 0.02 | Increment acceleration factor. |
| accelerationFactorMaximum | number | 0.2 | Maximum acceleration factor value. |
| seriesType | anychart.enums.StockSeriesType | string | "marker" | Series type for PSAR indicator. |
Returns:
anychart.core.stock.indicators.PSAR - Returns a PSAR (Parabolic SAR) indicator.Try it:
psy
Creates a PSY (The Psychological Line) indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| period | number | 20 | Indicator period. |
| seriesType | anychart.enums.StockSeriesType | string | "line" | Series type for PSY indicator. |
Returns:
anychart.core.stock.indicators.PSY - Returns a PSY (The Psychological Line) indicator.Try it:
rangeArea
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|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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - An instance of the created series.Try it:
rangeColumn
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|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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.RangeColumn - An instance of the created series.Try it:
rangeSplineArea
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|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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.RangeSplineArea - An instance of the created series.Try it:
rangeStepArea
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|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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.RangeStepArea - An instance of the created series.Try it:
rat
Creates RAT (Ratiocator) indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| baseDate | * | 0 | Start date of calculation. Start date is displayed in indicator series name and uses inputDateTimeFormat. |
| seriesType | anychart.enums.StockSeriesType | string | "line" | Series type. |
rci
Creates a RCI (Rank Correlation Index) indicator on the plot.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| period | number | 12 | Indicator period. |
| seriesType | anychart.enums.StockSeriesType | string | "line" | Series type for RCI indicator. |
Returns:
anychart.core.stock.indicators.RCI - Returns a RCI (Rank Correlation Index) indicator.Try it:
removeAllSeries
Removes all series from chart.
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it:
removeSeries
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:
removeSeriesAt
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:
roc
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 | anychart.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.Try it:
rsi
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 | anychart.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.Try it:
selectedFill
Getter for 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 - Select fill color.Try it:
Setter for 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 |
|---|---|---|---|
| color | anychart.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.
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:
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:
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:
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:
sma
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 | anychart.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.Try it:
spline
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|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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.Spline - An instance of the created series.Try it:
splineArea
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|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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.SplineArea - An instance of the created series.Try it:
stepArea
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|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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.StepArea - An instance of the created series.Try it:
stepLine
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|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'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.StepLine - An instance of the created series.Try it:
stick
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|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'. |
| 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
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 | string | "sma" | Indicator %K smoothing type. |
| dMAType | anychart.enums.MovingAverageType | string | "sma" | Indicator %D smoothing type. |
| kSeriesType | anychart.enums.StockSeriesType | string | "line" | Series type for %K value. |
| dSeriesType | anychart.enums.StockSeriesType | string | "line" | Series type for %D value. |
Returns:
anychart.core.stock.indicators.Stochastic - Returns a Stochastic indicator.Try it:
thumbs
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 |
|---|---|---|---|
| settings | boolean | Object | null | null | Thumbs settings. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.trix
Creates a TRIX indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| period | number | 15 | Indicator TRIX period. |
| signalPeriod | number | 9 | Indicator signal period. |
| maType | anychart.enums.MovingAverageType | string | 'ema' | Indicator smoothing type. |
| signalMaType | anychart.enums.MovingAverageType | string | 'ema' | Indicator signal smoothing type. |
| trixSeriesType | anychart.enums.StockSeriesType | string | 'line' | TRIX series type. |
| signalSeriesType | anychart.enums.StockSeriesType | string | 'line' | Signal series type. |
Returns:
anychart.core.stock.indicators.TRIX - Returns TRIX indicator.Try it:
volumeMa
Creates a Volume + MA indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| maPeriod | number | 20 | Moving Average period. |
| maType | anychart.enums.MovingAverageType | string | 'sma' | Indicator smoothing type. |
| volumeSeriesType | anychart.enums.StockSeriesType | string | 'stick' | Volume series type. |
| maSeriesType | anychart.enums.StockSeriesType | string | 'line' | Moving Average series type. |
Returns:
anychart.core.stock.indicators.VolumeMA - Returns Volume + MA indicator.Try it:
vwap
Creates a Volume Weighted Average Price (VWAP) indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| vwapSeriesType | anychart.enums.StockSeriesType | string | 'line' | Indicator series type. |
Returns:
anychart.core.stock.indicators.VWAP - Returns VWAP indicator.Try it:
williamsR
Creates a Williams %R indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| period | number | 10 | Period. |
| seriesType | anychart.enums.StockSeriesType | string | "line" | Series type for Williams %R indicator. |
Returns:
anychart.core.stock.indicators.WilliamsR - Returns a Williams %R indicator.Try it:
wma
Creates WMA (Weighted Moving Average) indicator on the scroller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mapping | anychart.data.TableMapping | Data mapping. | |
| period | number | 9 | Period. |
| seriesType | anychart.enums.StockSeriesType | string | "line" | Series type for WMA indicator (type as "line", "column", "area"). |
Returns:
anychart.core.stock.indicators.WMA - Returns WMA (Weighted Moving Average) indicator.Try it:
xAxis
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 |
|---|---|---|
| settings | Object | boolean | null | Chart 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:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | anychart.enums.ScatterScaleTypes | string | anychart.scales.ScatterBase | Object | anychart.scales.Linear | Scale settings to set. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it:
zIndex
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| zIndex | number | 0 | Value to set. |
Returns:
anychart.core.stock.Scroller - Self instance for method chaining.Try it: