class anychart.core.axisMarkers.CurrentPriceIndicator Improve this Doc

Stock current price indicator class.

Methods Overview

Specific settings
value()	Price indicator value.
valueField()	Price indicator value field.
Axes and Scales
axis()	Axis settings.
Coloring
fallingStroke()	Falling stroke settings.
risingStroke()	Rising stroke settings.
stroke()	Stroke settings.
Interactivity
enabled()	Element state (enabled or disabled).
Markers elements
fallingLabel()	Falling label settings.
label()	Label settings.
risingLabel()	Rising label settings.
Series
series()	Target series for a price indicator.
Size and Position
zIndex()	Z-index of the element.

Methods Description

axis

axis()Since version 8.0.0

Getter for the target axis.

Returns:

anychart.core.axes.Linear - Axis instance.

See listing

var priceIndicator = plot.priceIndicator();
var axis = priceIndicator.axis();

axis(indexOrAxis)Since version 8.0.0

Setter for the target axis.

Params:

Name	Type	Description
indexOrAxis	number \| anychart.core.axes.Linear	Axis index or axis instance to set.

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

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

fallingLabel

fallingLabel()Since version 8.0.0

Getter for the price indicator falling label.

Returns:

anychart.core.ui.Label - Label instance.

See listing

var priceIndicator = plot.priceIndicator();
var fallingLabel = priceIndicator.fallingLabel();

fallingLabel(index, settings)Since version 8.0.0

Setter for the price indicator falling label.

Detailed description

Falling label is set to the falling value of the price indicator. When falling label is not set, the price indicator uses anychart.core.axisMarkers.CurrentPriceIndicator#label value. Sets price indicator label settings by index depending on parameter type:

null/boolean - disable or enable price indicator label.
object - sets chart label settings.

Params:

Name	Type	Default	Description
index	string \| number		Label index.
settings	null \| boolean \| Object	true	Label settings.

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Self instance for method chaining.

Try it:

fallingStroke

fallingStroke()Since version 8.0.0

Getter for the price indicator falling stroke.

Returns:

anychart.graphics.vector.Stroke - Falling stroke settings.

See listing

var priceIndicator = plot.priceIndicator();
var fallingStroke = priceIndicator.fallingStroke();

fallingStroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 8.0.0

Setter for the price indicator falling stroke.

Detailed description

Falling stroke is set to the falling value of the price indicator. When falling stroke is not set, the price indicator uses anychart.core.axisMarkers.CurrentPriceIndicator#stroke value. Learn more about stroke settings.

Params:

Name	Type	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null	Stroke settings.
thickness	number	Line thickness.
dashpattern	string	Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	string \| anychart.graphics.vector.StrokeLineJoin	Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap	Line cap style.

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Self instance for method chaining.

Try it:

Usage sample

fallingStroke(settings)Since version 8.0.0

Setter for falling stroke using an object.

Params:

Name	Type	Description
settings	Object	Stroke settings from anychart.graphics.vector.Stroke.

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Self instance for method chaining.

Try it:

Usage sample

label

label()Since version 8.0.0

Getter for the price indicator label.

Returns:

anychart.core.ui.LabelsFactory - Labels factory instance.

See listing

var priceIndicator = plot.priceIndicator();
var label = priceIndicator.label();

label(index, settings)Since version 8.0.0

Setter for the price indicator label.

Detailed description

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

null/boolean - disable or enable price indicator label.
object - sets chart label settings.

Params:

Name	Type	Default	Description
index	string \| number		Label index.
settings	null \| boolean \| Object	true	Label settings.

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Self instance for method chaining.

Try it:

risingLabel

risingLabel()Since version 8.0.0

Getter for the price indicator rising label.

Returns:

anychart.core.ui.Label - Label instance.

See listing

var priceIndicator = plot.priceIndicator();
var risingLabel = priceIndicator.risingLabel();

risingLabel(index, settings)Since version 8.0.0

Setter for the price indicator rising label.

Detailed description

Rising label is set to the rising value of the price indicator. When rising label is not set, the price indicator uses anychart.core.axisMarkers.CurrentPriceIndicator#label value. Sets price indicator label settings by index depending on parameter type:

null/boolean - disable or enable price indicator label.
object - sets chart label settings.

Params:

Name	Type	Default	Description
index	string \| number		Label index.
settings	null \| boolean \| Object	true	Label settings.

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Self instance for method chaining.

Try it:

risingStroke

risingStroke()Since version 8.0.0

Getter for the price indicator rising stroke.

Returns:

anychart.graphics.vector.Stroke - Rising stroke settings.

See listing

var priceIndicator = plot.priceIndicator();
var risingStroke = priceIndicator.risingStroke();

risingStroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 8.0.0

Setter for the price indicator rising stroke.

Detailed description

Rising stroke is set to the rising value of the price indicator. When rising stroke is not set, the price indicator uses anychart.core.axisMarkers.CurrentPriceIndicator#stroke value. Learn more about stroke settings.

Params:

Name	Type	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null	Stroke settings.
thickness	number	Line thickness.
dashpattern	string	Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	string \| anychart.graphics.vector.StrokeLineJoin	Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap	Line cap style.

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Self instance for method chaining.

Try it:

Usage sample

risingStroke(settings)Since version 8.0.0

Setter for rising stroke using an object.

Params:

Name	Type	Description
settings	Object	Stroke settings from anychart.graphics.vector.Stroke.

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Self instance for method chaining.

Try it:

Usage sample

series

series()Since version 8.0.0

Getter for the target series.

Returns:

anychart.core.stock.series.Base - Series instance.

See listing

var priceIndicator = plot.priceIndicator();
var series = priceIndicator.series();

series(indexOrSeries)Since version 8.0.0

Setter for the target series.

Params:

Name	Type	Description
indexOrSeries	number \| anychart.core.stock.series.Base	Index or series instance.

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Self instance for method chaining.

Try it:

Usage sample

stroke

stroke()Since version 8.0.0

Getter for the price indicator stroke.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.

See listing

var priceIndicator = plot.priceIndicator();
var stroke = priceIndicator.stroke();

stroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 8.0.0

Setter for the price indicator stroke. Learn more about stroke settings.

Params:

Name	Type	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null	Stroke settings.
thickness	number	Line thickness.
dashpattern	string	Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	string \| anychart.graphics.vector.StrokeLineJoin	Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap	Line cap style.

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Self instance for method chaining.

Try it:

Usage sample

stroke(settings)

Setter for price indicator stroke settings using an object.

Params:

Name	Type	Description
settings	Object	Object with stroke settings from anychart.graphics.vector.Stroke

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Self instance for method chaining.

Try it:

Usage sample

value

value()Since version 8.0.0

Getter for the price indicator value.

Returns:

anychart.enums.PriceIndicatorDataSource | string | number | Date - Price indicator value.

See listing

var priceIndicator = plot.priceIndicator();
var value = priceIndicator.value();

value(value)Since version 8.0.0

Setter for the stock price indicator.

Params:

Name	Type	Default	Description
value	anychart.enums.PriceIndicatorDataSource \| string \| number \| Date	'series-start'	Value to set.

Returns:

anychart.core.axisMarkers.CurrentPriceIndicator - Self instance for method chaining.

Try it:

Usage sample

valueField

valueField()Since version 8.0.0

Getter for the price indicator value field.

Returns:

string - Price indicator value field.

See listing

var priceIndicator = plot.priceIndicator();
var valueField = priceIndicator.valueField();

valueField(fieldName)Since version 8.0.0

Setter for the price indicator value field.
valueField() method use with anychart.core.axisMarkers.CurrentPriceIndicator#value method. This method sets the field to be used as the value for the price indicator

Params: