AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated v7 version of this document. Switch to the v8 version to see the up to date information.

class anychart.core.stock.Plot Improve this Doc

Extends: anychart.core.VisualBaseWithBounds

Stock Plot class.

Methods Overview

Specific settings
addSeries()Add series to chart.
annotations()Creates annotations.
defaultSeriesType()Default series type.
getSeriesAt()Gets 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.
Axes and Scales
grid()Grid settings.
minorGrid()Minor grid settings.
xAxis()X-axis settings.
yAxis()Y-axis settings.
yScale()Y-scale settings.
Chart Coloring
hatchFillPalette()Hatch fill palette settings.
markerPalette()Markers palette settings.
palette()Palette settings.
Chart Controls
legend()Legend settings.
Coloring
background()Background settings.
dateTimeHighlighter()Highlighter settings.
Events
listen()Adds an event listener.
listenOnce()Adds a single time event listener.
removeAllListeners()Removes all listeners.
unlisten()Removes the listener.
unlistenByKey()Removes the listener by the key.
Export
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
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 Spline Area series.
rangeStepArea()Adds Range Step Area series.
spline()Adds Spline series.
splineArea()Adds Spline Area series.
stepArea()Adds Step Area series.
stepLine()Adds Step line series.
stick()Adds Stick series.
Size and Position
bottom()Bottom bound setting.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds.
height()Height setting.
left()Left bound setting.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
right()Right bound setting.
top()Top bound setting.
width()Width setting.
zIndex()Z-index of the element.
Technical Indicators
adl()Creates an Accumulation Distribution Line indicator on the plot.
ama()Creates AMA (Adaptive Moving Average) indicator on the plot.
aroon()Creates Aroon indicator on the plot.
atr()Creates an Average True Range indicator on the plot.
bbands()Creates Bollinger Bands indicator on the plot.
bbandsB()Creates %B indicator on the plot.
bbandsWidth()Creates Bollinger Bands Width indicator on the plot.
cci()Creates a Commodity Channel Index indicator on the chart.
cho()Creates a Chaikin Oscillator indicator on the chart.
cmf()Creates a Chaikin Money Flow indicator on the chart.
dmi()Creates a Directional Movement Index indicator on the chart.
ema()Creates EMA (Exponential Moving Average) indicator on the plot.
kdj()Creates a KDJ indicator on the plot.
macd()Creates MACD (Moving Average Convergence Divergence) indicator on the plot.
mma()Creates MMA (Modified Moving Average) indicator on the plot.
roc()Creates RoC (Rate of Change) indicator on the plot.
rsi()Creates RSI (Relative Strength Index) indicator on the plot.
sma()Creates SMA (Simple Moving Average) indicator on the plot.
stochastic()Creates a Stochastic indicator on the plot.

Methods Description

addSeries

Add series to chart.

Params:

NameTypeDescription
var_argsanychart.data.TableMappingChart series data.

Returns:

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

adl

Creates an Accumulation Distribution Line indicator on the plot.

Params:

NameTypeDescription
mappinganychart.data.TableMappingData mapping.
seriesTypeanychart.enums.StockSeriesTypeSeries type.

Returns:

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

ama

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

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 - An instance of the created series.

annotations

Getter for the plot annotations.

Returns:

anychart.core.annotations.PlotController - The plot annotations.
Setter for the plot annotations.

Params:

NameTypeDescription
annotationsListArrayAnnotations list to set.

Returns:

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

area

Creates and returns a new Area series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringData for the series.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

aroon

Creates Aroon indicator on the plot.

Params:

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

Returns:

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

atr

Creates an Average True Range indicator on the plot.

Params:

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

Returns:

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

background

Getter for the current plot background.

Returns:

anychart.core.ui.Background - The current chart background.
Setter for the plot background.

Params:

NameTypeDescription
valuestring | Object | null | booleanBackground settings.

Returns:

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

bbands

Creates Bollinger Bands indicator on the plot.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Moving average period value.
deviationnumber
2
The multiplier is applied to the moving average to compute upper and lower bands of the 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.
middleSeriesTypeanychart.enums.StockSeriesType | string
"line"
Middle Series type for the Bollinger Bands indicator.

Returns:

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

bbandsB

Creates %B indicator on the plot.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Moving average period value.
deviationnumber
2
The multiplier is 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 - An instance of the created series.

bbandsWidth

Creates Bollinger Bands Width indicator on the plot.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Moving average period value.
deviationnumber
2
The multiplier is 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 - An instance of the created series.

bottom

Getter for element bottom bound setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Bottom bound setting for the element.

Returns:

anychart.core.stock.Plot - Returns self for method chaining.

bounds

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.
Sets bounds of the element using one parameter.

Params:

NameTypeDescription
valueanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.core.stock.Plot - Self instance for method chaining.
Setter for the element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

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

candlestick

Creates and returns a new Candlestick series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringData for the series.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

cci

Creates a Commodity Channel Index indicator on the chart.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
periodnumber
20
Moving average period value.
seriesTypeanychart.enums.StockSeriesType
Series type.

Returns:

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

cho

Creates a Chaikin Oscillator indicator on the chart.

Params:

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

Returns:

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

cmf

Creates a Chaikin Money Flow indicator on the chart.

Params:

NameTypeDescription
mappinganychart.data.TableMappingData mapping.
periodnumberMoving average period value.
seriesTypeanychart.enums.StockSeriesTypeSeries type.

Returns:

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

column

Creates and returns a new Column series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

dateTimeHighlighter

Getter for the current highlighter.

Returns:

anychart.graphics.vector.Stroke - The current highlighter.
Setter for the highlighter.

Params:

NameTypeDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | nullStroke settings
thicknessnumberLine thickness. If empty - set to 1.
dashpatternstringControls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoinLine join style.
lineCapanychart.graphics.vector.StrokeLineCapStyle of line cap.

Returns:

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

defaultSeriesType

Getter for the default stock plot series type.

Returns:

string | anychart.enums.StockSeriesType - Default series type.
Setter for the stock plot defaultSeriesType.

Params:

NameTypeDescription
valuestring | anychart.enums.StockSeriesTypeDefault series type.

Returns:

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

dmi

Creates a Directional Movement Index indicator on the chart.

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
"line"
Type for +DI series.
ndiSeriesTypeanychart.enums.StockSeriesType
"line"
Type for -DI series.
adxSeriesTypeanychart.enums.StockSeriesType
"line"
Type for ADX series.

Returns:

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

ema

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

Params:

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

Returns:

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

enabled

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

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

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

getPixelBounds

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

Returns:

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

getSeries

Gets series by its id.

Params:

NameTypeDefaultDescription
idnumber | string
index
Id of the series.

Returns:

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

getSeriesAt

Gets series by its index.

Params:

NameTypeDescription
indexnumberIndex of the series.

Returns:

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

getSeriesCount

Returns series count.

Returns:

number - Number of series.

grid

Getter for the current plot grid.

Params:

NameTypeDescription
indexnumberGrid index.

Returns:

anychart.core.grids.Stock - Grid instance by index.
Setter for the plot grid.

Params:

NameTypeDescription
valueObject | boolean | nullGrid settings to set.

Returns:

anychart.core.stock.Plot - Self instance for method chaining.
Setter for the plot grid by index.

Params:

NameTypeDescription
indexnumberGrid index.
valueObject | boolean | nullGrid settings to set.

Returns:

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

hatchFillPalette

Getter for the current hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - The current plot hatch fill palette.
See listing
var currentHatchFillPalette = plot.hatchFillPalette();
Setter for hatch fill palette settings.

Params:

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

Returns:

anychart.palettes.HatchFills | anychart.core.stock.Plot - Self instance for method chaining.

height

Getter for element height setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Height setting for the element.

Returns:

anychart.core.stock.Plot - Returns self 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, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

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

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, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

kdj

Creates a KDJ indicator on the plot.

Params:

NameTypeDefaultDescription
mappinganychart.data.TableMapping
Data mapping.
kPeriodnumber
14
Moving average period value for %K.
kMAPeriodnumber
5
Indicator %K smoothing period.
dPeriodnumber
5
Moving average period value for %D.
kMATypeanychart.enums.MovingAverageType
"ema"
Indicator %K smoothing type.
dMATypeanychart.enums.MovingAverageType
"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
"line"
Series type for %K value.
dSeriesTypeanychart.enums.StockSeriesType
"line"
Series type for %D value.
jSeriesTypeanychart.enums.StockSeriesType
"line"
Series type for %J value.

Returns:

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

left

Getter for element left bound setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Left bound setting for the element.

Returns:

anychart.core.stock.Plot - Returns self for method chaining.

legend

Getter for the plot legend.

Returns:

anychart.core.ui.Legend - An instance of the class for method chaining.
Setter for the plot legend setting.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Legend settings.

Returns:

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

line

Creates and returns a new Line series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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
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 plot.

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.
macdSeriesTypestring | anychart.enums.StockSeriesType
"line"
Series type for MACD indicator (type as "line", "column", "ohlc").
signalSeriesTypestring | anychart.enums.StockSeriesType
"line"
Series type for signal (type as "line", "column", "ohlc").
histogramSeriesTypestring | anychart.enums.StockSeriesType
"column"
Series type for histogram (type as "line", "column", "ohlc").

Returns:

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

marker

Creates and returns a new Marker series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringData for the series.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

markerPalette

Getter for chart markers palette settings.

Returns:

anychart.palettes.Markers - Chart markers palette.
See listing
var markerPalette = plot.markerPalette();
Setter for the chart markers palette settings.

Params:

NameTypeDescription
valueanychart.palettes.Markers | Object | Array.<anychart.enums.MarkerType>Chart marker palette settings to set.

Returns:

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

maxHeight

Getter for maximum height.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

maxWidth

Getter for maximum width.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minHeight

Getter for minimum height.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minWidth

Getter for minimum width.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minorGrid

Getter for the current plot grid.

Params:

NameTypeDescription
indexnumberMinor grid index.

Returns:

anychart.core.grids.Stock - Minor grid instance by index.
Setter for the plot grid.

Params:

NameTypeDescription
valueObject | boolean | nullMinor grid settings to set.

Returns:

anychart.core.stock.Plot - Self instance for method chaining.
Setter for the plot grid by index.

Params:

NameTypeDescription
indexOrValuenumberMinor grid index.
valueObject | boolean | nullMinor grid settings to set.

Returns:

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

mma

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

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 - An instance of the created series.

ohlc

Creates and returns a new OHLC series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringValue to set.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

palette

Getter for the current series colors palette.
Setter for the series colors palette.

Params:

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

Returns:

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

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.

rangeArea

Creates and returns a new Range Area series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringData for the series.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.stock.series.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.<*>> | stringData for the series.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.stock.series.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.<*>> | stringData for the series.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

rangeStepArea

Creates and returns a new Range Step Area series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringData for the series.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

removeSeries

Removes one of series from chart by its id.

Params:

NameTypeDescription
idnumber | stringSeries id.

Returns:

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

removeSeriesAt

Removes one of series from chart by its index.

Params:

NameTypeDescription
indexnumberSeries index.

Returns:

anychart.core.stock.Plot - Self instance for method chaining.
Getter for element right bound setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Right bound setting for the element.

Returns:

anychart.core.stock.Plot - Returns self for method chaining.

roc

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

Params:

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

Returns:

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

rsi

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

Params:

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

Returns:

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

sma

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

Params:

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

Returns:

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

spline

Creates and returns a new Spline series.

Params:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringData for the series.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.stock.series.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.<*>> | stringData for the series.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.stock.series.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.<*>> | stringData for the series.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.stock.series.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.<*>> | stringData for the series.
mappingSettingsObject.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.stock.series.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, weights: number}|number)>An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettingsObjectIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

stochastic

Creates a Stochastic indicator on the plot.

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
SMA
Indicator %K smoothing type.
dMATypeanychart.enums.MovingAverageType
SMA
Indicator %D smoothing type.
kSeriesTypeanychart.enums.StockSeriesType
"line"
Series type for %K value.
dSeriesTypeanychart.enums.StockSeriesType
"line"
Series type for %D value.

Returns:

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

top

Getter for element top bound setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Top bound setting for the element.

Returns:

anychart.core.stock.Plot - Returns self for method chaining.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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.

width

Getter for element width setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Width setting for the element.

Returns:

anychart.core.stock.Plot - Returns self for method chaining.

xAxis

Getter for the current X-axis.

Returns:

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

Params:

NameTypeDescription
valueObject | boolean | nullChart axis settings to set.

Returns:

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

yAxis

Getter for the current plot Y-axis.

Params:

NameTypeDescription
indexnumberAxis index.

Returns:

anychart.core.axes.Linear - Axis instance by index.
Setter for the plot Y-axis.

Params:

NameTypeDescription
valueObject | boolean | nullChart axis settings to set.

Returns:

anychart.core.stock.Plot - Self instance for method chaining.
Setter for the Y-axis by index.

Params:

NameTypeDescription
indexnumberAxis index.
valueObject | boolean | nullChart axis settings to set.

Returns:

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

yScale

Getter for the default plot Y-scale.

Returns:

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

Params:

NameTypeDescription
valueanychart.enums.ScatterScaleTypes | anychart.scales.ScatterBaseY-scale to set.

Returns:

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

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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