AnyChart
API Reference
Still have questions?
Contact support
Top

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

Getter for the accessibility setting.

Returns:

anychart.core.utils.SeriesA11y - Accessibility settings object.
See listing.
var series = chart.line([3, 5, 2, 14, 3]);
var a11y = series.a11y();
Setter for the accessibility setting.

Params:

NameTypeDescription
valueboolean | ObjectWhether to enable accessibility.

Returns:

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

bottom

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.
Setter for element bottom bound settings.

Params:

NameTypeDefaultDescription
bottomnumber | string | null
null
Bottom bound settings for the element.

Returns:

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

bounds

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
Setter for bounds of the element using one parameter.

Params:

NameTypeDescription
boundsanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Setter for element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

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

clip

Getter for series clip settings.

Returns:

boolean | anychart.math.Rect - Clip settings.
Setter for series clip settings.

Params:

NameTypeDefaultDescription
valueboolean | 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.

color

Getter for the series color.

Returns:

string - Series color.
Setter for the series color.

Params:

NameTypeDescription
colorstringColor as a string.

Returns:

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

colorScale

Getter for the color scale.
See listing
var series = chart.line();
var colorScale = series.colorScale();
Setter for the color scale.

Params:

NameTypeDescription
settingsanychart.scales.LinearColor | anychart.scales.OrdinalColor | Object | anychart.enums.ScaleTypes | stringScale to set.

Returns:

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

data

Getter for series mapping.

Returns:

anychart.data.View - Returns series mapping.
Setter for series mapping.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData to set.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettingsIf 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.

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

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

excludePoint

Excludes points at the specified index.

Params:

NameTypeDescription
indexesnumber | Array.<number>Points indexes.

Returns:

boolean - Returns true if the points were excluded.

fallingFill

Getter for the falling series fill color.

Returns:

anychart.graphics.vector.Fill - Falling fill color.
Setter for falling fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.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.
Setter for falling fill settings using function.

Params:

NameTypeDefaultDescription
fillFunctionfunction():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.
Falling fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Linear gradient falling fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Radial gradient falling fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Image falling fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

fallingHatchFill

Getter for falling hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Falling hatch fill settings.
Setter for falling hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
null
Type of the hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Setter for falling hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Setter for falling hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Setter for falling hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Setter for falling hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

fallingStroke

Getter for falling stroke settings.

Returns:

anychart.graphics.vector.Stroke | function - Falling stroke settings.
Setter for series falling stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():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.
Setter for falling stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Setter for falling stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

getExcludedPoints

Returns an array of excluded points.

Returns:

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

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

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

Returns:

number - Point width.

getPoint

Gets wrapped point by index.

Params:

NameTypeDescription
indexnumberPoint index.

Returns:

anychart.core.SeriesPoint - Wrapped point.

getStat

Gets the statistics value by key.

Params:

NameTypeDescription
keyanychart.enums.Statistics | stringKey.

Returns:

* - Statistics value.

height

Getter for element height settings.

Returns:

number | string | undefined - Element's height setting.
Setter for element height setting.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Height settings for the element.

Returns:

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

hover

Hovers points.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Hovers point by index.

Params:

NameTypeDescription
indexnumberPoint index.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Hovers points by indexes.

Params:

NameTypeDescription
indexesArray.<number>Array of indexes.

Returns:

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

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings
Setter for hovered state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

id

Getter for the series id.

Returns:

string | number - Series id.
Setter for the series id.

Params:

NameTypeDescription
idstring | numberId of the series. Default id is equal to internal index.

Returns:

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

includeAllPoints

Includes all excluded points.

Returns:

boolean - Returns true if all points were included.

includePoint

Includes excluded points with the specified indexes.

Params:

NameTypeDescription
indexesnumber | Array.<number>Points indexes.

Returns:

boolean - Returns true if the points were included.

isVertical

Getter for the series layout direction.

Returns:

boolean - The flag of the series layout direction.
See listing
var flag = series.isVertical();
Setter for the series layout direction. Set it to null to reset to the default. Learn more about Vertical chart.

Params:

NameTypeDescription
enabledboolean | nullWhether to change the series layout direction to vertical.

Returns:

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

keepOnlyPoints

Keep only the specified points.

Params:

NameTypeDescription
indexesnumber | Array.<number>Point index or indexes.

labels

Getter for series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for series data labels.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Series data labels settings.

Returns:

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

left

Getter for element left bound settings.

Returns:

number | string | undefined - Element's left bound setting.
Setter for element left bound settings.

Params:

NameTypeDefaultDescription
leftnumber | string | null
null
Left bound setting for the element.

Returns:

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

legendItem

Getter for legend item settings for series.

Returns:

anychart.core.utils.LegendItemSettings - Legend item settings.
Setter for legend item settings for series.

Params:

NameTypeDescription
settingsObjectLegend item settings object.

Returns:

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

markers

Getter for series data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.
Setter for series data markers.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null | string
false
Series data markers settings.

Returns:

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

maxHeight

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.
Setter for the maximum height.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Maximum height to set.

Returns:

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

maxLabels

Getter for maximum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for maximum labels.

Params:

NameTypeDescription
settingsObject | boolean | nullMaximum labels settings.

Returns:

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

maxPointWidth

Getter for the maximum point width.

Returns:

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

Params:

NameTypeDescription
widthnumber | stringPoint width pixel value.

Returns:

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

maxWidth

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.
Setter for the maximum width.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Maximum width to set.

Returns:

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

meta

Getter for series meta data.

Params:

NameTypeDescription
key*Metadata key.

Returns:

* - Metadata object, key value or itself for method chaining.
Setter for series meta data using object.

Params:

NameTypeDescription
object*Object to replace metadata.
value*Meta data value.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Setter for series meta data using key.

Params:

NameTypeDescription
key*Metadata key.
value*Meta data value.

Returns:

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

minHeight

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.
Setter for the minimum height.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Minimum height to set.

Returns:

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

minLabels

Getter for minimum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for minimum labels.

Params:

NameTypeDescription
settingsObject | boolean | nullMinimum labels settings.

Returns:

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

minPointLength

Getter for the minimum point length.

Returns:

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

Params:

NameTypeDescription
lengthnumber | stringMinimum point length pixel value.

Returns:

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

minWidth

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.
Setter for the minimum width.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Minimum width to set.

Returns:

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

name

Getter for the series name.

Returns:

string | undefined - Series name.
Setter for the series name.

Params:

NameTypeDescription
namestringSeries name to set.

Returns:

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

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.
Setter for normal state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

pointWidth

Getter for the point width settings.

Returns:

string | number - The point width pixel value.
Setter for the point width settings.

Params:

NameTypeDefaultDescription
widthnumber | string
'90%'
Point width pixel value.

Returns:

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

rendering

Getter for the series rendering.

Returns:

anychart.core.series.RenderingSettings - Rendering settings.
Setter for the series rendering settings.

Params:

NameTypeDescription
settingsObject | functionRendering settings to set.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Getter for element right bound settings.

Returns:

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

Params:

NameTypeDefaultDescription
rightnumber | string | null
null
Right bound setting for the element.

Returns:

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

risingFill

Getter for the rising fill color.

Returns:

anychart.graphics.vector.Fill - Rising fill color.
Setter for rising fill settings using an array, an array or a string. Learn more about hatch fill settings.

Params:

NameTypeDescription
coloranychart.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.
Setter for rising fill settings using function.

Params:

NameTypeDefaultDescription
fillFunctionfunction():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.
Rising fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Linear gradient rising fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Radial gradient rising fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Image rising fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

risingHatchFill

Getter for rising hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Rising hatch fill settings.
Setter for rising hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
null
Type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Setter for rising hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Setter for rising hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Setter for rising hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Setter for rising hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

risingStroke

Getter for rising stroke settings.

Returns:

anychart.graphics.vector.Stroke | function - Stroke settings.
Setter for series rising stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():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.
Setter for rising stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Setter for rising stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

select

Selects point by index.

Params:

NameTypeDescription
indexnumberIndex of the point to select.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Selects point by indexes.

Params:

NameTypeDescription
indexesnumber | Array.<number>Array of indexes of the point to select.

Returns:

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

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings
Setter for selected state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

selectionMode

Gets the state of the series for selection mode.

Returns:

anychart.enums.SelectionMode | string | null - Selection mode.
Allows to select points of the series. To select multiple points, press 'ctrl' and click on them.

Params:

NameTypeDefaultDescription
valueanychart.enums.SelectionMode | string | null
'multiSelect'
Selection mode.

Returns:

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

seriesType

Getter for switching of the series type.

Returns:

string - Series type.
Setter for switching of the series type.

Params:

NameTypeDescription
typestringSeries type to set.

Returns:

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

tooltip

Getter for the series data tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Setter for the series data tooltip.

Params:

NameTypeDescription
settingsObject | boolean | nullTooltip settings.

Returns:

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

top

Getter for element top bound settings.

Returns:

number | string | undefined - Element's top bound setting.
Setter for element top bound settings.

Params:

NameTypeDefaultDescription
topnumber | string | null
null
Top bound setting for the element.

Returns:

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

transformX

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

Params:

NameTypeDescription
value*X value.
subRangeRationumberRange ratio value.

Returns:

number - Pixel value.

transformY

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

Params:

NameTypeDescription
value*Y value.
subRangeRationumberRange ratio value.

Returns:

number - Pixel value.

unhover

Removes hover from the series.

Params:

NameTypeDescription
indexOrIndexesnumber | Array.<number>Point index or array of indexes.

Returns:

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

unselect

Deselects all selected points.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Deselects selected point by index.

Params:

NameTypeDescription
indexnumberIndex of the point to select.

Returns:

anychart.core.cartesian.series.Candlestick - Self instance for method chaining.
Deselects selected points by indexes.

Params:

NameTypeDescription
indexesArray.<number>An array of indexes of the point to select.

Returns:

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

width

Getter for element width settings.

Returns:

number | string | undefined - Element's width setting.
Setter for element width setting.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Width settings for the element.

Returns:

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

xPointPosition

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

Returns:

number - X-point position.
Setter for the position of the point on an ordinal scale.

Params:

NameTypeDefaultDescription
positionnumber
0.5
Point position (in 0 to 1 range).

Returns:

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

xScale

Getter for the series X scale.

Returns:

anychart.scales.Ordinal - Series X scale.
Setter for the series X scale.

Params:

NameTypeDefaultDescription
settingsanychart.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.

yScale

Getter for the series Y scale.

Returns:

anychart.scales.Base - Series Y Scale.
Setter for the series Y scale.

Params:

NameTypeDefaultDescription
settingsanychart.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.

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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