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

Extends: anychart.core.cartesian.series.OHLC

Candlestick Series Class.
Note: Use anychart.charts.Cartesian#candlestick method to get this series.
Learn more about Candlestick series

Methods Overview

Specific settings
a11y()	Accessibility settings.
clip()	Series clip settings.
getPixelPointWidth()	Gets point width in case of width-based series.
id()	Series id.
legendItem()	Legend item settings.
maxPointWidth()	Maximum point width settings.
minPointLength()	Minimum point length settings.
pointWidth()	Point width settings.
selectionMode()	Selection mode.
transformX()	Transforms X value to pixel coordinates.
transformY()	Transforms Y value to pixel coordinates.
xPointPosition()	Position of the point.
Coloring
color()	Color settings.
colorScale()	Color scale settings.
fallingFill()	Falling fill settings.
fallingHatchFill()	Falling hatch fill settings.
fallingStroke()	Falling stroke settings.
risingFill()	Rising fill settings.
risingHatchFill()	Rising hatch fill settings.
risingStroke()	Rising stroke settings.
Data
data()	Data settings.
excludePoint()	Excludes points at the specified index.
getExcludedPoints()	Returns an array of excluded points.
getStat()	Gets the statistics value by key.
includeAllPoints()	Includes all excluded points.
includePoint()	Includes excluded points with the specified indexes.
keepOnlyPoints()	Keep only the specified points.
meta()	Series meta data settings.
name()	Series name settings.
Interactivity
enabled()	Element state (enabled or disabled).
hover()	Hover settings.
hovered()	Hovered state settings.
normal()	Normal state settings.
select()	Select settings.
selected()	Selected state settings.
tooltip()	Tooltip settings.
unhover()	Removes hover from the series.
unselect()	Deselects all selected points.
Point Elements
getPoint()	Gets wrapped point by index.
labels()	Labels settings.
markers()	Markers settings.
maxLabels()	Maximum labels settings.
minLabels()	Minimum labels settings.
Scales
xScale()	X-scale settings.
yScale()	Y-scale settings.
Series
rendering()	Rendering settings
seriesType()	Switch the series type
Size and Position
bottom()	Bottom bound settings.
bounds()	Bounds settings.
getPixelBounds()	Returns pixel bounds.
height()	Height settings.
left()	Left bound settings.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
right()	Right bound settings.
top()	Top bound settings.
width()	Width settings.
zIndex()	Z-index of the element.
Miscellaneous
isVertical()	Getter for the series layout direction.

Methods Description

a11y()Since version 7.11.0

a11y(value)Since version 7.11.0

Setter for the accessibility setting.

Detailed description

Params:

Name	Type	Description
value	boolean \| Object	Whether to enable accessibility.

Returns:

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

Try it:

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

Try it:

Usage sample

clip

clip()

Getter for series clip settings.

Returns:

boolean | anychart.math.Rect - Clip settings.

Try it:

Usage sample

clip(value)

Setter for series clip settings.

Detailed description

Clips visible part of a series by a rectangle (or chart).

Params:

Name	Type	Default	Description
value	boolean \| anychart.math.Rect	False, if series is created manually. True, if created via chart	Enable/disable series clip.

Returns:

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

Try it:

Usage sample

color

color()Since version 7.7.0

Getter for the series color.

Returns:

string - Series color.

Try it:

Usage sample

color(color)Since version 7.7.0

Setter for the series color.

Detailed description

Note: color methods sets fill and stroke settings, which means it is not wise to pass image fill here - stroke doesn't accept image fill.
Learn more about coloring.

Params:

Name	Type	Description
color	string	Color as a string.

Returns:

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

Try it:

Usage sample

colorScale

colorScale()Since version 8.3.0

Getter for the color scale.

Returns:

anychart.scales.LinearColor | anychart.scales.OrdinalColor - Color scale instance.

See listing

var series = chart.line();
var colorScale = series.colorScale();

colorScale(settings)Since version 8.3.0

Setter for the color scale.

Params:

Name	Type	Description
settings	anychart.scales.LinearColor \| anychart.scales.OrdinalColor \| Object \| anychart.enums.ScaleTypes \| string	Scale to set.

Returns:

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

Try it:

Usage sample

data

data()Since version 7.7.0

Getter for series mapping.

Returns:

anychart.data.View - Returns series mapping.

Try it:

Usage sample

data(data, csvSettings)Since version 7.7.0

Setter for series mapping.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data to set.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If CSV string is passed by first param, you can pass CSV parser settings here as a hash map.

Returns:

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

Try it:

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

Example.

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

Try it:

Usage sample

excludePoint

excludePoint(indexes)Since version 7.10.0

Excludes points at the specified index.

Params:

Name	Type	Description
indexes	number \| Array.<number>	Points indexes.

Returns:

boolean - Returns true if the points were excluded.

Try it:

Usage sample

fallingFill

fallingFill()

Getter for the 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 - Falling fill color.

Try it:

Usage sample

fallingFill(color)

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

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	null	Color as an object, an array or a string.

Returns:

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

Try it:

fallingFill(fillFunction)

Setter for falling fill settings using function.

Params:

Name	Type	Default	Description
fillFunction	function():anychart.graphics.vector.Fill	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 fillValue; // type anychart.graphics.vector.Fill }

Name

Type

Default

Description

fillFunction

function():anychart.graphics.vector.Fill

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 fillValue; // type anychart.graphics.vector.Fill
}

Returns:

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

Try it:

Usage sample

fallingFill(color, opacity)

Falling fill color with opacity.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Description
color	string	Color as a string.
opacity	number	Color opacity.

Returns:

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

Try it:

Usage sample

fallingFill(keys, angle, mode, opacity)

Linear gradient falling fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

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

Try it:

Usage sample

fallingFill(keys, cx, cy, mode, opacity, fx, fy)

Radial gradient falling fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

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

Try it:

Usage sample

fallingFill(imageSettings)

Image falling fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

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

Try it:

Usage sample

fallingHatchFill

fallingHatchFill()

Getter for 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 - Falling hatch fill settings.

Try it:

Usage sample

fallingHatchFill(type, color, thickness, size)

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

Params:

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

Returns:

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

Try it:

Usage sample

fallingHatchFill(hatchFillFunction)

Setter for falling hatch fill settings using function. Learn more about coloring.

Params:

Name	Type	Description
hatchFillFunction	function	HatchFill function.

Returns:

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

Try it:

Usage sample

fallingHatchFill(patternFill)

Setter for falling hatch fill settings using pattern fill. Learn more about coloring.

Params:

Name	Type	Description
patternFill	anychart.graphics.vector.PatternFill	Pattern fill to set.

Returns:

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

Try it:

Usage sample

fallingHatchFill(settings)

Setter for falling hatch fill settings using an instance. Learn more about coloring.

Params:

Name	Type	Description
settings	anychart.graphics.vector.HatchFill	Hatch fill instance.

Returns:

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

Try it:

Usage sample

fallingHatchFill(enabled)

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

Params:

Name	Type	Default	Description
enabled	boolean	false	Whether to enable hatch fill or no.

Returns:

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

Try it:

Usage sample

fallingStroke

fallingStroke()

Getter for falling stroke settings.

Detailed description

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

Returns:

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

Try it:

Usage sample

fallingStroke(strokeFunction)

Setter for series falling stroke by function.

Params:

Name	Type	Default	Description
strokeFunction	function():anychart.graphics.vector.Stroke\|anychart.graphics.vector.ColoredFill	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 }

Name

Type

Default

Description

strokeFunction

function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill

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

Try it:

Usage sample

fallingStroke(color, thickness, dashpattern, lineJoin, lineCap)

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

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null		Stroke settings.
thickness	number	1	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.cartesian.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

fallingStroke(settings)

Setter for falling stroke using an object.

Params:

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

Returns:

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

Try it:

Usage sample

getExcludedPoints

getExcludedPoints()Since version 7.10.0

Returns an array of excluded points.

Returns:

Array.<anychart.core.Point> - Array of the points.

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.

getPixelPointWidth

getPixelPointWidth()Since version 7.8.0

Gets point width in case of width-based series. Note: Works only after anychart.charts.Cartesian#draw is called.

Returns:

number - Point width.

Try it:

Usage sample

getPoint

getPoint(index)Since version 7.8.0

Gets wrapped point by index.

Params:

Name	Type	Description
index	number	Point index.

Returns:

anychart.core.SeriesPoint - Wrapped point.

Try it:

Usage sample

getStat

getStat(key)Since version 7.8.0

Gets the statistics value by key.

Params:

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

Returns:

* - Statistics value.

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.cartesian.series.Candlestick - Returns self for method chaining.

Try it:

Usage sample

hover

hover()Since version 7.7.0

Hovers points.

Detailed description

If index is passed, hovers a point of the series by its index, else hovers all points of the series.

Returns:

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

Try it:

Usage sample

hover(index)Since version 7.7.0

Hovers point by index.

Params:

Name	Type	Description
index	number	Point index.

Returns:

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

Try it:

Usage sample

hover(indexes)Since version 7.7.0

Hovers points by indexes.

Params:

Name	Type	Description
indexes	Array.<number>	Array of indexes.

Returns:

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

Try it:

Usage sample

hovered

hovered()Since version 8.0.0

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Usage sample

hovered(settings)Since version 8.0.0

Setter for hovered state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

id

id()Since version 7.8.0

Getter for the series id.

Returns:

string | number - Series id.

Try it:

Usage sample

id(id)Since version 7.8.0

Setter for the series id.

Detailed description

If you will set series id that is equal to an existing index, all changes will be set for the first series with this index.

Params:

Name	Type	Description
id	string \| number	Id of the series. Default id is equal to internal index.

Returns:

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

Try it:

Usage sample

includeAllPoints

includeAllPoints()Since version 7.10.0

Includes all excluded points.

Returns:

boolean - Returns true if all points were included.

Try it:

Usage sample

includePoint

includePoint(indexes)Since version 7.10.0

Includes excluded points with the specified indexes.

Params:

Name	Type	Description
indexes	number \| Array.<number>	Points indexes.

Returns:

boolean - Returns true if the points were included.

Try it:

Usage sample

isVertical

isVertical()Since version 7.13.0

Getter for the series layout direction.

Returns:

boolean - The flag of the series layout direction.

See listing

var flag = series.isVertical();

isVertical(enabled)Since version 7.13.0

Setter for the series layout direction. Set it to null to reset to the default. Learn more about Vertical chart.

Params:

Name	Type	Description
enabled	boolean \| null	Whether to change the series layout direction to vertical.

Returns:

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

Try it:

Usage sample

keepOnlyPoints

keepOnlyPoints(indexes)Since version 7.10.0

Keep only the specified points.

Params:

Name	Type	Description
indexes	number \| Array.<number>	Point index or indexes.

Try it:

Usage sample

labels

labels()

Getter for series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

labels(settings)

Setter for series data labels.

Detailed description

Sets series labels settings depending on parameter type:

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

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	false	Series data labels settings.

Returns:

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

Try it:

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.cartesian.series.Candlestick - Returns self for method chaining.

Try it:

Usage sample

legendItem

legendItem()Since version 7.7.0

Getter for legend item settings for series.

Returns:

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

Try it:

Usage sample

legendItem(settings)Since version 7.7.0

Setter for legend item settings for series.

Params:

Name	Type	Description
settings	Object	Legend item settings object.

Returns:

anychart.core.cartesian.series.Candlestick - Legend item settings or self for chaining.

Try it:

Usage sample

markers

markers()

Getter for series data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

markers(settings)

Setter for series data markers.

Detailed description

Sets series markers settings depending on parameter type:

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

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null \| string	false	Series data markers settings.

Returns:

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

Try it:

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

Try it:

Usage sample

maxLabels

maxLabels()Since version 8.2.0

Getter for maximum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

maxLabels(settings)Since version 8.2.0

Setter for maximum labels.

Detailed description

Sets chart labels settings depending on parameter type:

null/boolean - disable or enable maximum labels.
object - sets maximum labels settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Maximum labels settings.

Returns:

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

Try it:

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

Try it:

Usage sample

Name	Type	Description
key	*	Metadata key.

Name	Type	Description
object	*	Object to replace metadata.
value	*	Meta data value.

Name	Type	Description
key	*	Metadata key.
value	*	Meta data value.

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

Try it:

Usage sample

minLabels

minLabels()Since version 8.2.0

Getter for minimum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

minLabels(settings)Since version 8.2.0

Setter for minimum labels.

Detailed description

Sets chart labels settings depending on parameter type:

null/boolean - disable or enable minimum labels.
object - sets minimum labels settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Minimum labels settings.

Returns:

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

Try it:

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

Try it:

Usage sample

name

name()

Getter for the series name.

Detailed description

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

Returns:

string | undefined - Series name.

Try it:

Usage sample

name(name)

Setter for the series name.

Detailed description

Basically, name of series is used in Legend displaying, but it can be used in tooltips.

Params:

Name	Type	Description
name	string	Series name to set.

Returns:

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

Try it:

Usage sample

normal

normal()Since version 8.0.0

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Usage sample

normal(settings)Since version 8.0.0

Setter for normal state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

pointWidth

pointWidth()

Getter for the point width settings.

Returns:

string | number - The point width pixel value.

Try it:

Usage sample

pointWidth(width)

Setter for the point width settings.

Params:

Name	Type	Default	Description
width	number \| string	'90%'	Point width pixel value.

Returns:

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

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(settings)Since version 7.13.0

Setter for the series rendering settings.

Params:

Name	Type	Description
settings	Object \| function	Rendering settings to set.

Returns:

anychart.core.cartesian.series.Candlestick - 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.cartesian.series.Candlestick - Returns self for method chaining.

Try it:

Usage sample

risingFill

risingFill()

Getter for the 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 - Rising fill color.

Try it:

Usage sample

risingFill(color)

Setter for rising fill settings using an array, an array or a string. Learn more about hatch fill settings.

Params:

Name	Type	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	Color as an object, an array or a string.

Returns:

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

Try it:

risingFill(fillFunction)

Setter for rising fill settings using function.

Params:

Name

Type

Default

Description

fillFunction

function():anychart.graphics.vector.Fill

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 fillValue; // type anychart.graphics.vector.Fill
}

Returns:

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

Try it:

Usage sample

risingFill(color, opacity)

Rising fill color with opacity.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Description
color	string	Color as a string.
opacity	number	Color opacity.

Returns:

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

Try it:

Usage sample

risingFill(keys, angle, mode, opacity)

Linear gradient rising fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

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

Try it:

Usage sample

risingFill(keys, cx, cy, mode, opacity, fx, fy)

Radial gradient rising fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

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

Try it:

Usage sample

risingFill(imageSettings)

Image rising fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

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

Try it:

Usage sample

risingHatchFill

risingHatchFill()

Getter for 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 - Rising hatch fill settings.

Try it:

Usage sample

risingHatchFill(type, color, thickness, size)

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

Params:

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

Returns:

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

Try it:

Usage sample

risingHatchFill(hatchFillFunction)

Setter for rising hatch fill settings using function. Learn more about coloring.

Params:

Name	Type	Description
hatchFillFunction	function	HatchFill function.

Returns:

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

Try it:

Usage sample

risingHatchFill(patternFill)

Setter for rising hatch fill settings using pattern fill. Learn more about coloring.

Params:

Name	Type	Description
patternFill	anychart.graphics.vector.PatternFill	Pattern fill to set.

Returns:

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

Try it:

Usage sample

risingHatchFill(settings)

Setter for rising hatch fill settings using an instance. Learn more about coloring.

Params:

Name	Type	Description
settings	anychart.graphics.vector.HatchFill	Hatch fill instance.

Returns:

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

Try it:

Usage sample

risingHatchFill(enabled)

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

Params:

Name	Type	Default	Description
enabled	boolean	false	Whether to enable hatch fill or no.

Returns:

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

Try it:

Usage sample

risingStroke

risingStroke()

Getter for rising stroke settings.

Detailed description

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

Returns:

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

Try it:

Usage sample

risingStroke(strokeFunction)

Setter for series rising stroke by function.

Params:

Name

Type

Default

Description

strokeFunction

function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill

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

Try it:

Usage sample

risingStroke(color, thickness, dashpattern, lineJoin, lineCap)

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

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null		Stroke settings.
thickness	number	1	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.cartesian.series.Candlestick - 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.cartesian.series.Candlestick - Self instance for method chaining.

Try it:

Usage sample

select

select(index)Since version 7.7.0

Selects point by index.

Params:

Name	Type	Description
index	number	Index of the point to select.

Returns:

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

Try it:

Usage sample

select(indexes)Since version 7.7.0

Selects point by indexes.

Params:

Name	Type	Description
indexes	number \| Array.<number>	Array of indexes of the point to select.

Returns:

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

Try it:

Usage sample

selected

selected()Since version 8.0.0

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Usage sample

selected(settings)Since version 8.0.0

Setter for selected state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

selectionMode

selectionMode()Since version 7.7.0

Gets the state of the series for selection mode.

Returns:

anychart.enums.SelectionMode | string | null - Selection mode.

Try it:

Usage sample

selectionMode(value)Since version 7.7.0

Allows to select points of the series. To select multiple points, press 'ctrl' and click on them.

Params:

Name	Type	Default	Description
value	anychart.enums.SelectionMode \| string \| null	'multiSelect'	Selection mode.

Returns:

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

Try it:

Usage sample

seriesType

seriesType()Since version 7.10.0

Getter for switching of the series type.

Returns:

string - Series type.

Try it:

Usage sample

seriesType(type)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
type	string	Series type to set.

Returns:

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

Try it:

Usage sample

tooltip()Since version 7.7.0

tooltip(settings)Since version 7.7.0

Setter for the series data tooltip.

Detailed description

Params:

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

Returns:

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

Try it:

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.cartesian.series.Candlestick - Returns self for method chaining.

Try it:

Usage sample

transformX

transformX(value, subRangeRatio)Since version 7.8.0

Transforms X value to pixel coordinates. Note: Works only after anychart.charts.Cartesian#draw is called.

Params:

Name	Type	Description
value	*	X value.
subRangeRatio	number	Range ratio value.

Returns:

number - Pixel value.

Try it:

Usage sample

transformY

transformY(value, subRangeRatio)Since version 7.8.0

Transforms Y value to pixel coordinates. Note: Works only after anychart.charts.Cartesian#draw is called.

Params:

Name	Type	Description
value	*	Y value.
subRangeRatio	number	Range ratio value.

Returns:

number - Pixel value.

Try it:

Usage sample

unhover

unhover(indexOrIndexes)Since version 7.7.0

Removes hover from the series.

Params:

Name	Type	Description
indexOrIndexes	number \| Array.<number>	Point index or array of indexes.

Returns:

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

Try it:

Usage sample

unselect

unselect()Since version 7.7.0

Deselects all selected points.

Returns:

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

Try it:

Usage sample

unselect(index)Since version 7.7.0

Deselects selected point by index.

Params:

Name	Type	Description
index	number	Index of the point to select.

Returns:

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

Try it:

Usage sample

unselect(indexes)Since version 7.7.0

Deselects selected points by indexes.

Params:

Name	Type	Description
indexes	Array.<number>	An array of indexes of the point to select.

Returns:

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

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.cartesian.series.Candlestick - Returns self for method chaining.

Try it:

Usage sample

xPointPosition

xPointPosition()

Getter for the position of the point on an ordinal scale.

Returns:

number - X-point position.

Try it:

Usage sample

xPointPosition(position)

Setter for the position of the point on an ordinal scale.

Detailed description

For bars, columns and OHLC series it's autocalculated if chart contains more than one series.

On an ordinal scale, the position where point is can be set manually. If there are more than one series, positions is calculated to fit all.

Params:

Name	Type	Default	Description
position	number	0.5	Point position (in 0 to 1 range).

Returns:

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

Try it:

Usage sample

xScale

xScale()

Getter for the series X scale.

Returns:

anychart.scales.Ordinal - Series X scale.

Try it:

Usage sample

xScale(settings)

Setter for the series X scale.

Params:

Name	Type	Default	Description
settings	anychart.scales.Base \| Object \| anychart.enums.ScaleTypes \| string	anychart.scales.Ordinal	Scale settings to set.

Returns:

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

Try it:

Usage sample

yScale

yScale()

Getter for the series Y scale.

Returns:

anychart.scales.Base - Series Y Scale.

Try it:

Usage sample

yScale(settings)

Setter for the series Y scale.

Params:

Name	Type	Default	Description
settings	anychart.scales.Base \| Object \| anychart.enums.ScaleTypes \| string	anychart.scales.Linear	Scale settings to set.

Returns:

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

Try it:

Usage sample

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

Methods Overview

Methods Description

a11y

bottom

bounds

clip

color

colorScale

data

enabled

excludePoint

fallingFill

fallingHatchFill

fallingStroke

getExcludedPoints

getPixelBounds

getPixelPointWidth

getPoint

getStat

height

hover

hovered

id

includeAllPoints

includePoint

isVertical

keepOnlyPoints

labels

left

legendItem

markers

maxHeight

maxLabels

maxPointWidth

maxWidth

meta

minHeight

minLabels

minPointLength

minWidth

name

normal

pointWidth

rendering

right

risingFill

risingHatchFill