class anychart.core.stock.series.Candlestick Improve this Doc

Extends: anychart.core.stock.series.OHLC

Candlestick Series Class.
Learn more about Candlestick series

Methods Overview

Specific settings
legendItem()	Legend item settings.
pointWidth()	Point width settings.
Coloring
fallingFill()	Falling fill settings.
fallingHatchFill()	Falling hatch fill settings.
fallingStroke()	Stroke settings.
hoverFallingHatchFill()	Falling hatch fill settings in hover mode.
hoverRisingFill()	Rising fill settings in hover mode.
hoverRisingHatchFill()	Rising hatch fill settings in hover mode.
hoverRisingStroke()	Rising stroke settings in hover mode.
risingFill()	Rising fill settings.
risingHatchFill()	Rising hatch fill settings.
risingStroke()	Stroke settings.
selectFallingFill()	Falling fill settings in selected mode.
selectFallingHatchFill()	Falling hatch fill settings in selected mode.
selectRisingFill()	Rising fill settings in selected mode.
selectRisingHatchFill()	Rising hatch fill settings in selected mode.
Data
data()	Data settings.
name()	Series name settings.
Events
listen()	Adds an event listener.
listenOnce()	Adds a single time event listener.
removeAllListeners()	Removes all listeners.
unlisten()	Removes the listener.
unlistenByKey()	Removes the listener by the key.
Export
print()	Prints all elements.
Interactivity
enabled()	Element state (enabled or disabled).
Point Elements
markers()	Markers settings.
tooltip()	Tooltip settings.
Scales
yScale()	Y-scale settings.
Series
rendering()	Rendering settings
seriesType()	Switch the series type
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.

Methods Description

bottom

bottom()

Getter for element bottom bound setting.

Returns:

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

bottom(value)

Sets element bottom bound setting.

Params:

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

Returns:

anychart.core.stock.series.Candlestick - Returns self for method chaining.

Try it:

Usage sample

bounds

bounds()

Getter for the element bounds settings.

Returns:

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

bounds(value)

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

Try it:

Usage sample

bounds(x, y, width, height)

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

Try it:

Usage sample

data

data()Since version 7.7.0

Gets data for the series.

Returns:

anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string - Returns current mapping.

data(value, mappingSettings, csvSettings)Since version 7.7.0

Sets data for the series.

Params:

Name	Type	Description
value	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)>	Mapping settings. 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.Candlestick - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

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

Returns:

boolean - The current element state.

Try it:

Usage sample

Name	Type	Default	Description
value	boolean	true	Value to set.

fallingFill

fallingFill()

Getter for current falling series fill color.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Fill - The current falling fill color.

Try it:

Usage sample

fallingFill(value)

Setter for the falling fill settings using a string. Learn more about coloring.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	null	Color as an object or a string.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

fallingHatchFill

fallingHatchFill()

Getter for current falling hatch fill settings.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The current falling hatch fill.

See listing

var currentFallingHatchFill = series.fallingHatchFill();

fallingHatchFill(patternFillOrTypeOrState, color, thickness, size)

Setter for falling hatch fill settings. Learn more about hatch fill settings.

Params:

Name	Type	Default	Description
patternFillOrTypeOrState	anychart.graphics.vector.PatternFill \| anychart.graphics.vector.HatchFill \| function \| anychart.graphics.vector.HatchFill.HatchFillType \| string \| boolean	null	PatternFill or HatchFill instance or type of hatch fill.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

fallingStroke

fallingStroke()Since version 7.7.0

Getter for the current falling stroke settings.

Returns:

anychart.graphics.vector.Stroke - The current stroke settings.

Try it:

Usage sample

fallingStroke(value, thickness, dashpattern, lineJoin, lineCap)Since version 7.7.0

Setter for falling stroke settings. Learn more about stroke settings.

Params:

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

Returns:

anychart.core.stock.series.Candlestick - 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.

height

height()

Getter for element height setting.

Returns:

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

height(value)

Sets element height setting.

Params:

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

Returns:

anychart.core.stock.series.Candlestick - Returns self for method chaining.

Try it:

Usage sample

hoverFallingHatchFill

hoverFallingHatchFill()

Getter for current falling hatch fill settings in hover mode.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The current falling hatch fill.

See listing

var currentHoverFallingHatchFill = series.hoverFallingHatchFill();

hoverFallingHatchFill(patternFillOrType, color, thickness, size)

Setter for falling hatch fill settings in hover mode. Learn more about hatch fill settings.

Params:

Name	Type	Default	Description
patternFillOrType	anychart.graphics.vector.PatternFill \| anychart.graphics.vector.HatchFill \| function \| anychart.graphics.vector.HatchFill.HatchFillType \| string	null	PatternFill or HatchFill instance or type of hatch fill.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

hoverRisingFill

hoverRisingFill()

Getter for current series rising fill color in hover mode.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Fill - The current rising fill color.

Try it:

Usage sample

hoverRisingFill(value)

Setter for fill settings in hover mode using string. Learn more about coloring.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	null	Color as an object or a string.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

hoverRisingHatchFill

hoverRisingHatchFill()

Getter for current rising hatch fill settings in hover mode.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The current rising hatch fill.

See listing

var currentHoverRisingHatchFill = series.hoverRisingHatchFill();

hoverRisingHatchFill(patternFillOrType, color, thickness, size)

Setter for rising hatch fill settings in hover mode. Learn more about hatch fill settings.

Params:

Name	Type	Default	Description
patternFillOrType	anychart.graphics.vector.PatternFill \| anychart.graphics.vector.HatchFill \| function \| anychart.graphics.vector.HatchFill.HatchFillType \| string	null	PatternFill or HatchFill instance or type of hatch fill.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

hoverRisingStroke

hoverRisingStroke(fillFunction)Since version 7.7.0

Setter for series rising stroke by function.

Params:

Name	Type	Default	Description
fillFunction	function	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like `function(){ // this.index - series index. // this.sourceColor - color returned by fill() getter. // this.iterator - series point iterator. return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill }`.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

hoverRisingStroke()

Getter for the rising stroke settings in hover mode.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Stroke | function - The stroke settings.

Try it:

Usage sample

hoverRisingStroke(fillFunction)

Setter for series rising stroke in hover mode by function.

Params:

Name	Type	Default	Description
fillFunction	function	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like `function(){ // this.index - series index. // this.sourceColor - color returned by fill() getter. // this.iterator - series point iterator. return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill }`.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

hoverRisingStroke(stroke, thickness, dashpattern, lineJoin, lineCap)

Setter for rising stroke settings in hover mode. Learn more about stroke settings.

Params:

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

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

left

left()

Getter for element left bound setting.

Returns:

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

left(value)

Sets element left bound setting.

Params:

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

Returns:

anychart.core.stock.series.Candlestick - Returns self for method chaining.

Try it:

Usage sample

legendItem

legendItem()Since version 7.7.0

Gets the current legend item setting for series.

Returns:

anychart.core.utils.LegendItemSettings - Legend item settings.

Try it:

Usage sample

legendItem(value)Since version 7.7.0

Sets the legend item setting for series.

Params:

Name	Type	Description
value	Object	Legend item settings object.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

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:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

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:

Usage sample

markers

markers()

Getter for the data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

markers(value)

Setter for the data markers.

Detailed description

Sets chart markers settings depending on parameter type:

null/boolean - disable or enable chart markers.
object - sets chart markers settings.
string - sets chart markers type.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null \| string	false	Data markers settings.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

maxHeight

maxHeight()

Getter for maximum height.

Returns:

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

maxHeight(value)

Setter for maximum height.

Params:

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

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

maxWidth

maxWidth()

Getter for maximum width.

Returns:

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

maxWidth(value)

Setter for maximum width.

Params:

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

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

minHeight

minHeight()

Getter for minimum height.

Returns:

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

minHeight(value)

Setter for 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
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

minWidth

minWidth()

Getter for minimum width.

Returns:

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

minWidth(value)

Setter for 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
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

name

name()Since version 7.7.0

Gets the current series name.

Returns:

string - Series name.

Try it:

Usage sample

name(value)Since version 7.7.0

Sets the series name.

Params:

Name	Type	Description
value	string

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

pointWidth

pointWidth()Since version 7.7.0

Getter for current point width settings.

Returns:

string | number - Point width pixel value.

Try it:

Usage sample

pointWidth(value)Since version 7.7.0

Setter for the point width settings.

Params:

Name	Type	Default	Description
value	number \| string \| null	"75%"	Point width pixel value.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

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:

Usage sample

removeAllListeners

removeAllListeners(type)

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:

Usage sample

rendering

rendering()Since version 7.13.0

Getter for the series rendering.

Returns:

anychart.core.series.RenderingSettings - Rendering settings.

Try it:

Usage sample

rendering(value)Since version 7.13.0

Setter for the series rendering settings.

Params:

Name	Type	Description
value	Object \| function	Value to set.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

right

right()

Getter for element right bound setting.

Returns:

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

right(value)

Sets element right bound setting.

Params:

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

Returns:

anychart.core.stock.series.Candlestick - Returns self for method chaining.

Try it:

Usage sample

risingFill

risingFill()

Getter for current series rising fill color.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Fill - The current rising fill color.

Try it:

Usage sample

risingFill(value)

Setter for fill settings using string. Learn more about hatch fill settings.

Params:

Name	Type	Description
value	anychart.graphics.vector.Fill	Color as an array or a string.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

risingHatchFill

risingHatchFill()

Getter for current rising hatch fill settings.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The current rising hatch fill.

See listing

var currentRisingHatchFill = series.risingHatchFill();

risingHatchFill(patternFillOrTypeOrState, color, thickness, size)

Setter for rising hatch fill settings. Learn more about hatch fill settings.

Params:

Name	Type	Default	Description
patternFillOrTypeOrState	anychart.graphics.vector.PatternFill \| anychart.graphics.vector.HatchFill \| function \| anychart.graphics.vector.HatchFill.HatchFillType \| string \| boolean	null	PatternFill or HatchFill instance or type of hatch fill.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

risingStroke

risingStroke()Since version 7.7.0

Getter for the current rising stroke settings.

Returns:

anychart.graphics.vector.Stroke - The current stroke settings.

Try it:

Usage sample

risingStroke(value, thickness, dashpattern, lineJoin, lineCap)Since version 7.7.0

Setter for rising stroke settings. Learn more about stroke settings.

Params:

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

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

selectFallingFill

selectFallingFill()

Getter for current falling series fill color in selected mode.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Fill - The current falling fill color.

selectFallingFill(value)

Setter for the falling fill settings in selected mode using an array or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	null	Color as an object or a string.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

selectFallingHatchFill

selectFallingHatchFill()

Getter for current falling hatch fill settings in selected mode.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The current falling hatch fill.

selectFallingHatchFill(patternFillOrTypeOrState, color, thickness, size)

Setter for falling hatch fill settings in selected mode. Learn more about hatch fill settings.

Params:

Name	Type	Default	Description
patternFillOrTypeOrState	anychart.graphics.vector.PatternFill \| anychart.graphics.vector.HatchFill \| function \| anychart.graphics.vector.HatchFill.HatchFillType \| string \| boolean	null	PatternFill or HatchFill instance or type of hatch fill.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

selectRisingFill

selectRisingFill()

Getter for current series rising fill color in selected mode.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Fill - The current rising fill color.

selectRisingFill(value)

Setter for fill settings in selected mode using an array or a string. Learn more about hatch fill settings.

Params:

Name	Type	Description
value	anychart.graphics.vector.Fill	Color as an object or a string.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

selectRisingHatchFill

selectRisingHatchFill()

Getter for current rising hatch fill settings in selected mode.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | boolean - The current rising hatch fill.

selectRisingHatchFill(patternFillOrTypeOrState, color, thickness, size)

Setter for rising hatch fill settings. Learn more about hatch fill settings.

Params:

Name	Type	Default	Description
patternFillOrTypeOrState	anychart.graphics.vector.PatternFill \| anychart.graphics.vector.HatchFill \| function \| anychart.graphics.vector.HatchFill.HatchFillType \| string \| boolean	null	PatternFill or HatchFill instance or type of hatch fill.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

seriesType

seriesType()Since version 7.10.0

Getter for switching of the series type.

Returns:

string - Series type.

Try it:

Usage sample

seriesType(value)Since version 7.10.0

Setter for switching of the series type.

Detailed description

You can use seriesType() method to fast switching series type. Note: The switching of series type resets markers and labels settings.

Params:

Name	Type	Description
value	string	Series type.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

tooltip()Since version 7.7.0

tooltip(value)Since version 7.7.0

Setter for the tooltip.

Detailed description

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	true	Tooltip settings.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

top

top()

Getter for element top bound setting.

Returns:

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

top(value)

Sets element top bound setting.

Params:

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

Returns:

anychart.core.stock.series.Candlestick - Returns self for method chaining.

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

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:

Usage sample

unlistenByKey

unlistenByKey(key)

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:

Usage sample

width

width()

Getter for element width setting.

Returns:

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

width(value)

Sets element width setting.

Params:

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

Returns:

anychart.core.stock.series.Candlestick - Returns self for method chaining.

Try it:

Usage sample

yScale

yScale()Since version 7.7.0

Getter for the current Y-scale.

Returns:

anychart.scales.ScatterBase - Series Y-scale.

See listing

var myPlot = chart.plot();
var plotSeries = myPlot.line(data);
plotSeries.yScale();

yScale(value)Since version 7.7.0

Setter for the Y-scale.

Params:

Name	Type	Description
value	anychart.scales.ScatterBase	Value to set.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

zIndex

zIndex()

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Usage sample

zIndex(value)

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
value	number	0	Value to set.

Returns:

anychart.core.stock.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample