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.
title()	Title settings.
Axes and Scales
baseline()	Set the baseline by the Y-Scale value.
lineMarker()	Get or create a new line marker instance by index.
priceIndicator()	Price indicator settings.
rangeMarker()	Get or create a new range marker instance by index.
textMarker()	Get or create a new text marker instance by index.
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.
dataArea()	Data area settings.
Data
getStat()	Getter for a statistical value by the key.
noData()	NoData settings.
Interactivity
crosshair()	Crosshair settings
enabled()	Element state (enabled or disabled).
Point Elements
eventMarkers()	Event markers settings
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 settings.
bounds()	Bounds settings.
getPixelBounds()	Returns pixel bounds.
height()	Height settings.
isExpanded()	Getter method, whether plot is expanded.
left()	Left bound settings.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
moveDown()	Moves plot down in stock chart.
moveUp()	Moves plot up in stock chart.
right()	Right bound settings.
toggleExpandedState()	Toggles plot's "expanded" state.
top()	Top bound settings.
width()	Width settings.
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.
ao()	Creates an Awesome Oscillator indicator on the plot.
aroon()	Creates Aroon indicator on the plot.
aroonOscillator()	Creates Aroon Oscillator 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.
coppockCurve()	Creates a Coppock Curve indicator on the chart.
dmi()	Creates a Directional Movement Index indicator on the chart.
ema()	Creates EMA (Exponential Moving Average) indicator on the plot.
env()	Creates ENV (Envelope) indicator on the plot.
ha()	Creates a Heikin-Ashi indicator on the plot.
ikh()	Creates an Ichimoku Cloud (IKH) indicator on the plot.
kdj()	Creates a KDJ indicator on the plot.
keltnerChannels()	Creates a Keltner Channels indicator on the plot.
macd()	Creates MACD (Moving Average Convergence Divergence) indicator on the plot.
mfi()	Creates a MFI (Money Flow Index) indicator on the plot.
mma()	Creates MMA (Modified Moving Average) indicator on the plot.
momentum()	Creates a Momentum indicator on the plot.
obv()	Creates an On Balance Volume indicator on the plot.
ppo()	Creates PPO (Price Oscillator) indicator on the plot.
priceChannels()	Creates a Price Channels indicator on the plot.
psar()	Creates a PSAR (Parabolic SAR) indicator on the plot.
psy()	Creates a PSY (The Psychological Line) indicator on the plot.
rat()	Creates RAT (Ratiocator) indicator on the plot.
rci()	Creates a RCI (Rank Correlation Index) 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.
trix()	Creates a TRIX indicator on the plot.
volumeMa()	Creates a Volume + MA indicator on the plot.
vwap()	Creates a Volume Weighted Average Price (VWAP) indicator on the plot.
williamsR()	Creates a Williams %R indicator on the plot.
wma()	Creates WMA (Weighted Moving Average) indicator on the plot.

Methods Description

addSeries

addSeries(var_args)Since version 7.8.0

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:

Usage sample

adl

adl(mapping, seriesType)Since version 7.14.0

Creates an Accumulation Distribution Line indicator on the plot.

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:

Usage sample

ama

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

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 - Returns AMA (Adaptive Moving Average) indicator.

Try it:

Usage sample

annotations

annotations()Since version 7.11.0

Getter for the plot annotations.

Returns:

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

Try it:

Usage sample

annotations(annotationsList)Since version 7.11.0

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:

Usage sample

ao

ao(mapping, fastPeriod, slowPeriod, maType, seriesType)Since version 8.3.0

Creates an Awesome Oscillator indicator on the plot.

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:

Usage sample

area

area(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Area series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Data for the series.
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	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:

Usage sample

aroon

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

Creates Aroon indicator on the plot.

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:

Usage sample

aroonOscillator

aroonOscillator(mapping, period, seriesType)Since version 8.11.1

Creates Aroon Oscillator indicator on the plot.

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:

Usage sample

atr

atr(mapping, period, seriesType)Since version 7.13.0

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 \| string	"line"	Series type for the Average True Range indicator.

Returns:

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

Try it:

Usage sample

background

background()Since version 7.7.0

Getter for the plot background.

Returns:

anychart.core.ui.Background - Chart background.

Try it:

Usage sample

background(settings)Since version 7.7.0

Setter for the plot background.

Detailed description

Sets plot background settings depending on parameter type:

null/boolean - disable or enable plot background.
object - sets plot background settings.
string - sets color for plot background.

Params:

Name	Type	Description
settings	string \| Object \| null \| boolean	Background settings to set.

Returns:

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

Try it:

baseline

baseline()Since version 8.3.0

Getter for the baseline.

Returns:

number - The baseline value by the Y-Scale.

See listing

var plot = chart.plot();
var baseline = plot.baseline();

baseline(value)Since version 8.3.0

Setter for the baseline.
The baseline is the line relative to which the series with the negative or positive value is drawn and painted over.

Params:

Name	Type	Default	Description
value	number	0	Y-Scale value for the baseline.

Returns:

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

Try it:

Usage sample

bbands

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

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.
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:

Usage sample

bbandsB

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

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 - Returns %B indicator.

Try it:

Usage sample

bbandsWidth

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

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 - Returns Bollinger Bands Width indicator.

Try it:

Usage sample

bottom

bottom()

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.

bottom(bottom)

Setter for element bottom bound settings.

Params:

Name	Type	Default	Description
bottom	number \| string \| null	null	Bottom bound settings for the element.

Returns:

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

Try it:

Usage sample

bounds

bounds()

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.

bounds(bounds)

Setter for bounds of the element using one parameter.

Params:

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

Returns:

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

Try it:

Usage sample

bounds(x, y, width, height)

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

Try it:

Usage sample

candlestick

candlestick(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Candlestick series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Data for the series.
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	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:

Usage sample

cci

cci(mapping, period, seriesType)Since version 7.14.0

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 \| string		Series type.

Returns:

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

Try it:

Usage sample

cho

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

Creates a Chaikin Oscillator indicator on the chart.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
fastPeriod	number	3	Indicator fast period.
slowPeriod	number	10	Indicator slow period.
maType	anychart.enums.MovingAverageType \| 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:

Usage sample

cmf

cmf(mapping, period, seriesType)Since version 7.14.0

Creates a Chaikin Money Flow indicator on the chart.

Params:

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

Returns:

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

Try it:

Usage sample

column

column(data, mappingSettings, csvSettings)Since version 7.7.0

Creates and returns a new Column series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	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	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.

Try it:

coppockCurve

coppockCurve(mapping, wmaPeriod, firstRocPeriod, secondRocPeriod, seriesType)Since version 8.11.1

Creates a Coppock Curve indicator on the chart.

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:

Usage sample

crosshair

crosshair()Since version 7.6.0

Getter for crosshair settings.

Returns:

anychart.core.ui.Crosshair - Crosshair settings.

Try it:

Usage sample

crosshair(settings)Since version 8.0.0

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

Detailed description

Sets chart crosshair settings depending on parameter type:

null/boolean - disable or enable chart crosshair.
object - sets chart crosshair settings.

Params:

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

Returns:

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

Try it:

dataArea

dataArea()Since version 8.3.0

Getter for the data area settings.

Returns:

anychart.core.ui.DataArea - Data area settings.

Try it:

Usage sample

dataArea(settings)Since version 8.3.0

Setter for the data area settings.
The data area is drawn along the data bounds.

Detailed description

Sets data area settings depending on parameter type:

boolean - disable or enable data area.
object - sets data area settings.

Params:

Name	Type	Description
settings	Object \| boolean	Data area settings to set.

Returns:

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

Try it:

defaultSeriesType

defaultSeriesType()Since version 7.8.0

Getter for the default stock plot series type.

Returns:

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

Try it:

Usage sample

defaultSeriesType(type)Since version 7.8.0

Setter for the stock plot defaultSeriesType.

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

Try it:

Usage sample

dmi

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

Creates a Directional Movement Index indicator on the chart.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
period	number	14	Moving average period value.
adxPeriod	number	14	Period for ADX.
useWildersSmoothing	boolean	true	Wilders smoothing mode.
pdiSeriesType	anychart.enums.StockSeriesType \| 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:

Usage sample

ema

ema(mapping, period, seriesType)Since version 7.9.0

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	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:

Usage sample

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

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

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

env

env(mapping, period, deviation, maType, upperSeriesType, lowerSeriesType)Since version 8.7.0

Creates ENV (Envelope) indicator on the plot.

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:

Usage sample

eventMarkers

eventMarkers()Since version 8.1.0

Getter for the event markers controller.

Returns:

anychart.core.stock.eventMarkers.Controller - Plot controller instance.

Try it:

Usage sample

eventMarkers(value)Since version 8.1.0

Setter for the event markers controller.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	true	Value to set.

Returns:

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

Try it:

Usage sample

getPixelBounds

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

getSeries(id)Since version 7.7.0

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:

Usage sample

getSeriesAt

getSeriesAt(index)Since version 7.8.0

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:

Usage sample

getSeriesCount

getSeriesCount()Since version 7.8.0

Returns series count.

Returns:

number - Number of series.

Try it:

Usage sample

getStat

getStat(key)Since version 8.3.0

Getter for a statistical value by the key.

Params:

Name	Type	Description
key	anychart.enums.Statistics \| string	Key.

Returns:

* - Statistics value.

Try it:

Usage sample

ha

ha(mapping, seriesType)Since version 8.3.0

Creates a Heikin-Ashi indicator on the plot.

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:

Usage sample

hatchFillPalette

hatchFillPalette()Since version 7.10.0

Getter for the hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - The plot hatch fill palette.

See listing

var hatchFillPalette = plot.hatchFillPalette();

hatchFillPalette(value)Since version 7.10.0

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:

Usage sample

height

height()

Getter for element height settings.

Returns:

number | string | undefined - Element's height setting.

height(height)

Setter for element height setting.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Height settings for the element.

Returns:

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

Try it:

Usage sample

hilo

hilo(data, mappingSettings, csvSettings)Since version 7.14.0

Creates and returns a new HiLo series.

Params:

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

Try it:

Usage sample

ikh

ikh(mapping, conversionPeriod, basePeriod, leadingPeriod, conversionSeriesType, baseSeriesType, leadingSeriesType, laggingSeriesType)Since version 8.7.0

Creates an Ichimoku Cloud (IKH) indicator on the plot.

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:

Usage sample

isExpanded

isExpanded()

Getter method, whether plot is expanded.

Returns:

boolean - Whether the plot is expanded.

Try it:

Usage sample

jumpLine

jumpLine(data, mappingSettings, csvSettings)Since version 7.13.0

Creates and returns a new Jump Line series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: (anychart.enums.AggregationType\|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	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.

Try it:

kdj

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

Creates a KDJ indicator on the 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 \| 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:

Usage sample

keltnerChannels

keltnerChannels(mapping, maPeriod, atrPeriod, maType, multiplier, maSeries)Since version 8.3.0

Creates a Keltner Channels indicator on the plot.

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 smoothing 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:

Usage sample

left

left()

Getter for element left bound settings.

Returns:

number | string | undefined - Element's left bound setting.

left(left)

Setter for element left bound settings.

Params:

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

Returns:

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

Try it:

Usage sample

legend

legend()

Getter for the plot legend.

Returns:

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

Try it:

Usage sample

legend(value)

Setter for the plot legend setting.

Detailed description

Sets plot legend settings depending on parameter type:

null/boolean - disable or enable plot legend.
object - sets plot legend settings.

Params:

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

Returns:

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

Try it:

line

line(data, mappingSettings, csvSettings)Since version 7.7.0

Creates and returns a new Line series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	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	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.

Try it:

lineMarker

lineMarker(index)Since version 8.3.0

Getter for the plot line marker.

Params:

Name	Type	Description
index	number	Marker index.

Returns:

anychart.core.axisMarkers.Line - Line marker instance by index.

Try it:

Usage sample

lineMarker(settings)Since version 8.3.0

Setter for the plot line marker.

Detailed description

Sets plot line marker settings depending on parameter type:

null/boolean - disable or enable plot line marker.
object - sets plot line marker settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Plot line marker settings to set.

Returns:

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

Try it:

lineMarker(index, settings)Since version 8.3.0

Setter for the plot line marker settings by index.

Detailed description

Sets plot line marker settings by index depending on parameter type:

null/boolean - disable or enable plot line marker by index.
object - sets plot line marker settings by index.

Params:

Name	Type	Default	Description
index	number	0	Plot line marker index.
settings	Object \| boolean \| null		Plot line marker settings to set.

Returns:

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

Try it:

macd

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

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

Detailed description

MACD indicator shows the difference between fast and slow smoothing.
Use indicator in the plot without series.

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:

Usage sample

marker

marker(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Marker series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Data for the series.
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	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:

Usage sample

markerPalette

markerPalette()Since version 7.10.0

Getter for chart markers palette settings.

Returns:

anychart.palettes.Markers - Chart markers palette.

See listing

var markerPalette = plot.markerPalette();

markerPalette(value)Since version 7.10.0

Setter for the chart markers palette settings.

Params:

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

Returns:

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

Try it:

Usage sample

maxHeight

maxHeight()

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.

maxHeight(height)

Setter for the maximum height.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Maximum height to set.

Returns:

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

Try it:

Usage sample

maxPointWidth

maxPointWidth()Since version 8.0.0

Getter for the maximum point width.

Returns:

string | number - The maximum point width pixel value.

See listing

var maxPointWidth = plot.maxPointWidth();

maxPointWidth(width)Since version 8.0.0

Setter for the maximum point width.

Params:

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

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.

maxWidth(width)

Setter for the maximum width.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Maximum width to set.

Returns:

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

Try it:

Usage sample

mfi

mfi(mapping, period, seriesType)Since version 8.2.0

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

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 MFI (Money Flow Index) indicator.

Try it:

Usage sample

minHeight

minHeight()

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.

minHeight(height)

Setter for the minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Minimum height to set.

Returns:

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

Try it:

Usage sample

minPointLength

minPointLength()Since version 8.0.0

Getter for the minimum point length.

Returns:

string | number - The minimum point length pixel value.

See listing

var minPointLength = plot.minPointLength();

minPointLength(length)Since version 8.0.0

Setter for the minimum point length.

Params:

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

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.

minWidth(width)

Setter for the minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Minimum width to set.

Returns:

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

Try it:

Usage sample

mma

mma(mapping, period, seriesType)Since version 7.13.0

Creates MMA (Modified Moving Average) indicator on the 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 - Returns MMA (Modified Moving Average) indicator.

Try it:

Usage sample

momentum

momentum(mapping, period, seriesType)Since version 8.2.0

Creates a Momentum indicator on the plot.

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:

Usage sample

moveDown

moveDown()

Moves plot down in stock chart.

Returns:

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

Try it:

Usage sample

moveUp

moveUp()

Moves plot up in stock chart.

Returns:

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

Try it:

Usage sample

noData

noData()Since version 8.0.0

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.

Try it:

Usage sample

noData(value)Since version 8.0.0

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:

Usage sample

obv

obv(mapping, seriesType)Since version 8.3.0

Creates an On Balance Volume indicator on the plot.

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:

Usage sample

ohlc

ohlc(data, mappingSettings, csvSettings)Since version 7.7.0

Creates and returns a new OHLC series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	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	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.

Try it:

palette

palette()Since version 7.10.0

Getter for the series colors palette.

Returns:

anychart.palettes.RangeColors | anychart.palettes.DistinctColors - Color palette.

Try it:

Usage sample

palette(value)Since version 7.10.0

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:

Usage sample

pointWidth

pointWidth()Since version 8.0.0

Getter for the point width settings.

Returns:

string | number - The point width pixel value.

See listing

var pointWidth = plot.pointWidth();

pointWidth(value)Since version 8.0.0

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:

Usage sample

ppo

ppo(mapping, shortPeriod, longPeriod, smoothingPeriod, ppoSeriesType, signalSeriesType, histogramSeriesType)Since version 8.7.0

Creates PPO (Price Oscillator) indicator on the plot.

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:

Usage sample

priceChannels

priceChannels(mapping, period, middleSeriesType, rangeSeriesType)Since version 8.3.0

Creates a Price Channels indicator on the plot.

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.

Try it:

Usage sample

priceIndicator

priceIndicator(index)Since version 8.0.0

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:

Usage sample

priceIndicator(value)Since version 8.0.0

Setter for the stock price indicator settings.

Detailed description

Sets stock price indicator settings depending on parameter type:

null/boolean - disable or enable price indicator.
object - sets 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.

Try it:

priceIndicator(index, value)Since version 8.0.0

Setter for the stock price indicator settings by index.

Detailed description

Sets stock price indicator settings by index depending on parameter type:

null/boolean - disable or enable price indicator by index.
object - sets 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.

Try it:

psar

psar(mapping, accelerationFactorStart, accelerationFactorIncrement, accelerationFactorMaximum, seriesType)

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

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:

Usage sample

psy

psy(mapping, period, seriesType)Since version 8.7.0

Creates a PSY (The Psychological Line) indicator on the plot.

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:

Usage sample

rangeArea

rangeArea(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Range Area series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Data for the series.
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	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:

Usage sample

rangeColumn

rangeColumn(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Range Column series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Data for the series.
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	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:

Usage sample

rangeMarker

rangeMarker(index)Since version 8.3.0

Getter for the plot range marker.

Params:

Name	Type	Description
index	number	Range marker index.

Returns:

anychart.core.axisMarkers.Range - Range marker instance by index.

Try it:

Usage sample

rangeMarker(settings)Since version 8.3.0

Setter for the plot range marker.

Detailed description

Sets plot range marker settings depending on parameter type:

null/boolean - disable or enable plot range marker.
object - sets plot range marker settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Plot range marker settings to set.

Returns:

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

Try it:

rangeMarker(index, settings)Since version 8.3.0

Setter for the plot range marker settings by index.

Detailed description

Sets plot range marker settings by index depending on parameter type:

null/boolean - disable or enable plot range marker by index.
object - sets plot range marker settings by index.

Params:

Name	Type	Default	Description
index	number	0	Plot range marker index.
settings	Object \| boolean \| null		Plot range marker settings to set.

Returns:

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

Try it:

rangeSplineArea

rangeSplineArea(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Range Spline Area series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Data for the series.
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	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:

Usage sample

rangeStepArea

rangeStepArea(data, mappingSettings, csvSettings)Since version 7.10.0

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\|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	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:

Usage sample

rat

rat(mapping, baseDate, seriesType)Since version 8.7.0

Creates RAT (Ratiocator) indicator on the plot.

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

rci(mapping, period, seriesType)Since version 8.7.0

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:

Usage sample

removeAllSeries

removeAllSeries()Since version 7.8.0

Removes all series from chart.

Returns:

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

Try it:

Usage sample

removeSeries

removeSeries(id)Since version 7.8.0

Removes one of series from chart by its id.

Params:

Name	Type	Description
id	number \| string	Series id.

Returns:

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

Try it:

Usage sample

removeSeriesAt

removeSeriesAt(index)Since version 7.8.0

Removes one of series from chart by its index.

Params:

Name	Type	Description
index	number	Series index.

Returns:

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

Try it:

Usage sample

right

right()

Getter for element right bound settings.

Returns:

number | string | undefined - Element's right bound setting.

right(right)

Setter for element right bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

roc

roc(mapping, period, seriesType)Since version 7.9.0

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

Detailed description

Use indicator in the plot without series.

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:

Usage sample

rsi

rsi(mapping, period, seriesType)Since version 7.9.0

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

Detailed description

Use indicator in the plot without series.

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:

Usage sample

sma

sma(mapping, period, seriesType)Since version 7.9.0

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	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:

Usage sample

spline

spline(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Spline series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Data for the series.
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	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:

Usage sample

splineArea

splineArea(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Spline Area series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Data for the series.
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	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:

Usage sample

stepArea

stepArea(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Step Area series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Data for the series.
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	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:

Usage sample

stepLine

stepLine(data, mappingSettings, csvSettings)Since version 7.10.0

Creates and returns a new Step Line series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Data for the series.
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	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:

Usage sample

stick

stick(data, mappingSettings, csvSettings)Since version 7.13.0

Creates and returns a new Stick series.

Params:

Name	Type	Description
data	anychart.data.TableMapping \| anychart.data.Table \| Array.<Array.<*>> \| string	Value to set.
mappingSettings	Object.<string, ({column: number, type: (anychart.enums.AggregationType\|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	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.

Try it:

stochastic

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

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 \| 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:

Usage sample

textMarker

textMarker(index)Since version 8.3.0

Getter for the plot text marker.

Params:

Name	Type	Description
index	number	Text marker index.

Returns:

anychart.core.axisMarkers.Text - Range marker instance by index.

Try it:

Usage sample

textMarker(settings)Since version 8.3.0

Setter for the plot text marker.

Detailed description

Sets plot text marker settings depending on parameter type:

null/boolean - disable or enable plot text marker.
object - sets plot text marker settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Plot text marker settings to set.

Returns:

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

Try it:

textMarker(index, settings)Since version 8.3.0

Setter for the plot text marker settings by index.

Detailed description

Sets plot text marker settings by index depending on parameter type:

null/boolean - disable or enable plot text marker by index.
object - sets plot text marker settings by index.

Params:

Name	Type	Default	Description
index	number	0	Plot text marker index.
settings	Object \| boolean \| null		Plot text marker settings to set.

Returns:

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

Try it:

title

title()Since version 8.3.0

Getter for the plot title.

Returns:

anychart.core.ui.Title - The plot title.

Try it:

Usage sample

title(settings)Since version 8.3.0

Setter for the plot title.

Detailed description

Sets plot title settings depending on parameter type:

null/boolean - disable or enable plot title.
string - sets plot title text value.
object - sets plot title settings.

Params:

Name	Type	Description
settings	null \| boolean \| Object \| string	Plot title settings to set.

Returns:

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

Try it:

toggleExpandedState

toggleExpandedState()

Toggles plot's "expanded" state.

Returns:

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

Try it:

Usage sample

top

top()

Getter for element top bound settings.

Returns:

number | string | undefined - Element's top bound setting.

top(top)

Setter for element top bound settings.

Params:

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

Returns:

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

Try it:

Usage sample

trix

trix(mapping, period, signalPeriod, maType, signalMaType, trixSeriesType, signalSeriesType)Since version 8.3.0

Creates a TRIX indicator on the plot.

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	'ema'	Indicator smoothing type.
signalMaType	anychart.enums.MovingAverageType	'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:

Usage sample

volumeMa

volumeMa(mapping, maPeriod, maType, volumeSeriesType, maSeriesType)Since version 8.3.0

Creates a Volume + MA indicator on the plot.

Params:

Name	Type	Default	Description
mapping	anychart.data.TableMapping		Data mapping.
maPeriod	number	20	Moving Average period.
maType	anychart.enums.MovingAverageType \| string	'sma'	Indicator Moving Average 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:

Usage sample

vwap

vwap(mapping, vwapSeriesType)Since version 8.8.1

Creates a Volume Weighted Average Price (VWAP) indicator on the plot.

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:

Usage sample

width

width()

Getter for element width settings.

Returns:

number | string | undefined - Element's width setting.

width(width)

Setter for element width setting.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Width settings for the element.

Returns:

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

Try it:

Usage sample

williamsR

williamsR(mapping, period, seriesType)Since version 8.2.0

Creates a Williams %R indicator on the plot.

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:

Usage sample

wma

wma(mapping, period, seriesType)Since version 8.11.1

Creates WMA (Weighted Moving Average) indicator on the plot.

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:

Usage sample

xAxis

xAxis()Since version 7.7.0

Getter for the X-axis.

Returns:

anychart.core.axes.StockDateTime - Axis instance.

Try it:

Usage sample

xAxis(settings)Since version 7.7.0

Setter for the X-axis.

Detailed description

Sets plot X-axis settings depending on parameter type:

null/boolean - disable or enable plot X-axis.
object - sets plot X-axis settings.

Params:

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

Returns:

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

Try it:

xGrid

xGrid(index)Since version 8.0.0

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:

Usage sample

xGrid(settings)Since version 8.0.0

Setter for the plot grid by X-scale.

Detailed description

Sets plot grid settings depending on parameter type:

null/boolean - disable or enable plot grid.
object - sets plot grid settings.

Params:

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

Returns:

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

Try it:

xGrid(index, settings)Since version 8.0.0

Setter for the plot grid by index.

Detailed description

Sets plot grid by index settings depending on parameter type:

null/boolean - disable or enable plot grid by index.
object - sets plot grid settings by index.

Params:

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

Returns:

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

Try it:

xMinorGrid

xMinorGrid(index)Since version 8.0.0

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:

Usage sample

xMinorGrid(settings)Since version 8.0.0

Setter for the plot grid by X-scale.

Detailed description

Sets plot minor grid settings depending on parameter type:

null/boolean - disable or enable plot minor grid.
object - sets plot minor grid settings.

Params:

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

Returns:

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

Try it:

xMinorGrid(indexOrValue, settings)Since version 8.0.0

Setter for the plot grid by index.

Detailed description

Sets plot minor grid by index settings depending on parameter type:

null/boolean - disable or enable plot minor grid by index.
object - sets plot minor grid settings by index.

Params:

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

Returns:

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

Try it:

yAxis

yAxis(index)Since version 7.7.0

Getter for the plot Y-axis.

Params:

Name	Type	Description
index	number	Axis index.

Returns:

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

Try it:

Usage sample

yAxis(settings)Since version 7.7.0

Setter for the plot Y-axis.

Detailed description

Sets plot Y-axis settings depending on parameter type:

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

Params:

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

Returns:

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

Try it:

yAxis(index, settings)Since version 7.7.0

Setter for the Y-axis by index.

Detailed description

Sets plot Y-axis by index settings depending on parameter type:

null/boolean - disable or enable plot Y-axis by index.
object - sets plot Y-axis settings by index.

Params:

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

Returns:

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

Try it:

yGrid

yGrid(index)Since version 8.0.0

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:

Usage sample

yGrid(settings)Since version 8.0.0

Setter for the plot grid by Y-scale.

Detailed description

Sets plot grid settings depending on parameter type:

null/boolean - disable or enable plot grid.
object - sets plot grid settings.

Params:

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

Returns:

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

Try it:

yGrid(index, settings)Since version 8.0.0

Setter for the plot grid by index.

Detailed description

Sets plot grid by index settings depending on parameter type:

null/boolean - disable or enable plot grid by index.
object - sets plot grid settings by index.

Params:

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

Returns:

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

Try it:

yMinorGrid

yMinorGrid(index)Since version 8.0.0

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:

Usage sample

yMinorGrid(settings)Since version 8.0.0

Setter for the plot grid by Y-scale.

Detailed description

Sets plot minor grid settings depending on parameter type:

null/boolean - disable or enable plot minor grid.
object - sets plot minor grid settings.

Params:

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

Returns:

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

Try it:

yMinorGrid(indexOrValue, settings)Since version 8.0.0

Setter for the plot grid by index.

Detailed description

Sets plot minor grid by index settings depending on parameter type:

null/boolean - disable or enable plot minor grid by index.
object - sets plot minor grid settings by index.

Params:

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

Returns:

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

Try it:

yScale

yScale()Since version 7.7.0

Getter for the default plot Y-scale.

Returns:

anychart.scales.ScatterBase - Default chart scale value.

See listing

var plot = chart.plot();
var yScale = plot.yScale();

yScale(settings)Since version 7.7.0

Setter for the plot 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.Plot - Self instance for method chaining.

Try it:

Usage sample

zIndex

zIndex()

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Usage sample

zIndex(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.Plot - Self instance for method chaining.

Try it:

Usage sample