Top

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.
maxPointWidth()Maximum point width settings.
minPointLength()Minimum point length settings.
pointWidth()Point width settings.
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
priceIndicator()Price indicator settings.
xAxis()X-axis settings.
xGrid()Grid settings.
xMinorGrid()Minor grid settings by X-scale.
yAxis()Y-axis settings.
yGrid()Grid settings.
yMinorGrid()Minor grid settings by Y-scale.
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.
Data
noData()NoData 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
crosshair()Crosshair settings
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:

Name Type Description
var_args anychart.data.TableMapping Chart series data.

Returns:

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

Try it:

adl

Creates an Accumulation Distribution Line indicator on the plot.

Params:

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

Returns:

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

Try it:

ama

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

Params:

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

Returns:

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

Try it:

annotations

Getter for the plot annotations.

Returns:

anychart.core.annotations.PlotController - The plot annotations.

Try it:

Setter for the plot annotations.

Params:

Name Type Description
annotationsList Array Annotations list to set.

Returns:

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

Try it:

area

Creates and returns a new Area series.

Params:

Name Type Description
data anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string Data for the series.
mappingSettings Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)> An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettings Object If 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.

Try it:

aroon

Creates Aroon indicator on the plot.

Params:

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

Returns:

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

Try it:

atr

Creates an Average True Range indicator on the plot.

Params:

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

Returns:

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

Try it:

background

Getter for the current plot background.

Returns:

anychart.core.ui.Background - The current chart background.

Try it:

Setter for the plot background.

Params:

Name Type Description
value string | Object | null | boolean Background settings.

Returns:

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

bbands

Creates Bollinger Bands indicator on the plot.

Params:

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

Returns:

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

Try it:

bbandsB

Creates %B indicator on the plot.

Params:

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

Returns:

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

Try it:

bbandsWidth

Creates Bollinger Bands Width indicator on the plot.

Params:

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

Returns:

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

Try it:

bottom

Getter for element bottom bound setting.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

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:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

Setter for the element bounds settings.

Params:

Name Type Default Description
x number | string
null
X-coordinate.
y number | string
null
Y-coordinate.
width number | string
null
Width.
height number | string
null
Height.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

candlestick

Creates and returns a new Candlestick series.

Params:

Name Type Description
data anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string Data for the series.
mappingSettings Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)> An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettings Object If 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.

Try it:

cci

Creates a Commodity Channel Index indicator on the chart.

Params:

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

Returns:

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

Try it:

cho

Creates a Chaikin Oscillator indicator on the chart.

Params:

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

Returns:

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

Try it:

cmf

Creates a Chaikin Money Flow indicator on the chart.

Params:

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

Returns:

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

Try it:

column

Creates and returns a new Column series.

Params:

Name Type Description
data anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string Value to set.
mappingSettings Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)> An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettings Object If 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.

crosshair

Getter for crosshair settings.

Returns:

anychart.core.ui.Crosshair - Crosshair settings.

Try it:

Setter for crosshair settings.
The plot crosshair settings have a higher priority than the chart crosshair settings.

Params:

Name Type Description
value Object | boolean | null Crosshair settings.

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.

Try it:

Setter for the stock plot defaultSeriesType.

Params:

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

Returns:

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

Try it:

dmi

Creates a Directional Movement Index indicator on the chart.

Params:

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

Returns:

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

Try it:

ema

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

Params:

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

Returns:

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

Try it:

enabled

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

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

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:

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

Returns:

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

Try it:

getSeriesAt

Gets series by its index.

Params:

Name Type Description
index number Index of the series.

Returns:

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

Try it:

getSeriesCount

Returns series count.

Returns:

number - Number of series.

Try it:

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:

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

Returns:

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

Try it:

height

Getter for element height setting.

Returns:

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

Params:

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

Returns:

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

Returns:

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

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

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

Returns:

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

Try it:

left

Getter for element left bound setting.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

legend

Getter for the plot legend.

Returns:

anychart.core.ui.Legend - An instance of the class for method chaining.

Try it:

Setter for the plot legend setting.

Params:

Name Type Default Description
value Object | boolean | null
false
Legend settings.

Returns:

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

line

Creates and returns a new Line series.

Params:

Name Type Description
data anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string Value to set.
mappingSettings Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)> An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettings Object If 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:

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

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

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

Returns:

Object - Unique key for the listener.

Try it:

macd

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

Params:

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

Returns:

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

Try it:

marker

Creates and returns a new Marker series.

Params:

Name Type Description
data anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string Data for the series.
mappingSettings Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)> An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettings Object If 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.

Try it:

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:

Name Type Description
value anychart.palettes.Markers | Object | Array.<anychart.enums.MarkerType> Chart marker palette settings to set.

Returns:

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

Try it:

maxHeight

Getter for maximum height.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

maxPointWidth

Getter for the maximum point width.

Returns:

string number - The maximum point width pixel value.
See listing
var maxPointWidth = plot.maxPointWidth();
Setter for the maximum point width.

Params:

Name Type Description
value number | string Point width pixel value.

Returns:

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

Try it:

maxWidth

Getter for maximum width.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minHeight

Getter for minimum height.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minPointLength

Getter for the minimum point length.

Returns:

string number - The minimum point length pixel value.
See listing
var minPointLength = plot.minPointLength();
Setter for the minimum point length.

Params:

Name Type Description
value number | string Minimum point length pixel value.

Returns:

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

Try it:

minWidth

Getter for minimum width.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

mma

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

Params:

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

Returns:

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

Try it:

noData

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.

Try it:

Setter for noData settings.
Learn more about "No data" feature

Params:

Name Type Description
value Object NoData settings.

Returns:

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

Try it:

ohlc

Creates and returns a new OHLC series.

Params:

Name Type Description
data anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string Value to set.
mappingSettings Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)> An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettings Object If 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.

Try it:

Setter for the series colors palette.

Params:

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

Returns:

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

Try it:

pointWidth

Getter for the point width settings.

Returns:

string number - The point width pixel value.
See listing
var pointWidth = plot.pointWidth();
Setter for the point width settings.

Params:

Name Type Description
value number | string Point width pixel value.

Returns:

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

Try it:

priceIndicator

Getter for the stock price indicator.

Params:

Name Type Description
index number Index to set.

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Price indicator instance by index.

Try it:

Setter for the stock price indicator settings.

Params:

Name Type Description
value Object | boolean | null Chart price indicators settings to set.

Returns:

anychart.core.stock.Plot - Self instance for method chaining.
Setter for the stock price indicator settings by index.

Params:

Name Type Description
index number Stock price indicator
value Object | boolean | null Chart price indicators settings to set.

Returns:

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

print

Prints all elements on related stage.

Params:

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

Try it:

rangeArea

Creates and returns a new Range Area series.

Params:

Name Type Description
data anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string Data for the series.
mappingSettings Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)> An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettings Object If 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.

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

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

Try it:

rangeStepArea

Creates and returns a new Range Step Area series.

Params:

Name Type Description
data anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string Data for the series.
mappingSettings Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)> An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettings Object If 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.

Try it:

removeAllListeners

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

Params:

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

Returns:

number - Number of listeners removed.

Try it:

removeAllSeries

Removes all series from chart.

Returns:

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

Try it:

Getter for element right bound setting.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

roc

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

Params:

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

Returns:

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

Try it:

rsi

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

Params:

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

Returns:

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

Try it:

sma

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

Params:

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

Returns:

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

Try it:

spline

Creates and returns a new Spline series.

Params:

Name Type Description
data anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string Data for the series.
mappingSettings Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)> An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'.
csvSettings Object If 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.

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

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

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

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

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

Returns:

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

Try it:

top

Getter for element top bound setting.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

unlisten

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

Params:

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

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

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

Params:

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

Returns:

boolean - Whether any listener was removed.

Try it:

width

Getter for element width setting.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

xAxis

Getter for the current X-axis.

Returns:

anychart.core.axes.StockDateTime - Axis instance.

Try it:

Setter for the X-axis.

Params:

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

Returns:

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

xGrid

Getter for the plot grid by X-scale.

Params:

Name Type Description
index number Grid index.

Returns:

anychart.core.grids.Stock - Grid instance by index.

Try it:

Setter for the plot grid by X-scale.

Params:

Name Type Description
value Object | boolean | null Grid settings to set.

Returns:

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

Params:

Name Type Description
index number Grid index.
value Object | boolean | null Grid settings to set.

Returns:

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

xMinorGrid

Getter for the plot grid by X-scale.

Params:

Name Type Description
index number Minor grid index.

Returns:

anychart.core.grids.Stock - Minor grid instance by index.

Try it:

Setter for the plot grid by X-scale.

Params:

Name Type Description
value Object | boolean | null Minor grid settings to set.

Returns:

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

Params:

Name Type Description
indexOrValue number Minor grid index.
value Object | boolean | null Minor grid settings to set.

Returns:

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

yAxis

Getter for the current plot Y-axis.

Params:

Name Type Description
index number Axis index.

Returns:

anychart.core.axes.Linear - Axis instance by index.

Try it:

Setter for the plot Y-axis.

Params:

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

Returns:

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

Params:

Name Type Description
index number Axis index.
value Object | boolean | null Chart axis settings to set.

Returns:

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

yGrid

Getter for the plot grid by Y-scale.

Params:

Name Type Description
index number Grid index.

Returns:

anychart.core.grids.Stock - Grid instance by index.

Try it:

Setter for the plot grid by Y-scale.

Params:

Name Type Description
value Object | boolean | null Grid settings to set.

Returns:

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

Params:

Name Type Description
index number Grid index.
value Object | boolean | null Grid settings to set.

Returns:

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

yMinorGrid

Getter for the plot grid by Y-scale.

Params:

Name Type Description
index number Minor grid index.

Returns:

anychart.core.grids.Stock - Minor grid instance by index.

Try it:

Setter for the plot grid by Y-scale.

Params:

Name Type Description
value Object | boolean | null Minor grid settings to set.

Returns:

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

Params:

Name Type Description
indexOrValue number Minor grid index.
value Object | boolean | null Minor grid 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 plot = chart.plot();
plot.yScale();
Setter for the plot Y-scale.

Params:

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

Returns:

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

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: