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 | |
| clip() | Series clip settings. |
| getPixelPointWidth() | Gets point width in case of width-based series. |
| id() | Series id. |
| legendItem() | Legend item 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. |
| fallingFill() | Falling fill settings. |
| fallingHatchFill() | Falling hatch fill settings. |
| fallingStroke() | Falling stroke settings. |
| hoverFallingFill() | Falling fill settings in hover mode. |
| hoverFallingHatchFill() | Falling hatch fill settings in hover mode. |
| hoverFallingStroke() | Falling stroke 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() | Rising stroke settings. |
| selectFallingFill() | Falling fill settings in selected mode. |
| selectFallingHatchFill() | Falling hatch fill settings in selected mode. |
| selectFallingStroke() | Falling stroke settings in hover mode. |
| selectRisingFill() | Rising fill settings in selected mode. |
| selectRisingHatchFill() | Rising hatch fill settings in selected mode. |
| selectRisingStroke() | Rising stroke settings in selected mode. |
| Data | |
| data() | Data settings. |
| excludePoint() | Excludes points at the specified index. |
| getExcludedPoints() | Returns an array of excluded points. |
| 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. |
| 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). |
| hover() | Hover settings. |
| select() | Select settings. |
| tooltip() | Tooltip settings. |
| unhover() | Removes hover from the series. |
| unselect() | Deselects all selected points. |
| Point Elements | |
| getPoint() | Gets wrapped point by index. |
| hoverLabels() | Labels settings in hover mode. |
| hoverMarkers() | Markers settings in hover mode. |
| labels() | Labels settings. |
| markers() | Markers settings. |
| selectLabels() | Labels settings in selected mode. |
| selectMarkers() | Markers settings in selected mode. |
| Scales | |
| xScale() | X-scale settings. |
| 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. |
| Miscellaneous | |
| isVertical() | Getter for the series layout direction. |
Methods Description
bottom
Getter for element bottom bound setting.
Returns:
number | string | undefined - Current element's bottom bound setting.Sets element bottom bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Bottom bound setting for the element. |
Returns:
anychart.core.cartesian.series.Candlestick - Returns self for method chaining.Try it:
bounds
Getter for the element bounds settings.
Returns:
anychart.core.utils.Bounds - Current bounds of the element.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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
clip
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. | Enable/disable series clip. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
color
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.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | Color as a string. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
data
Setter for series mapping.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.data.View | anychart.data.Set | Array | string | Value to set. |
| csvSettings | anychart.enums.TextParsingMode | 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.enabled
Getter for the current element state (enabled or disabled).
Returns:
boolean - The current element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | true | Value to set. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
excludePoint
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:
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:
Setter for falling fill settings 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Setter for falling fill settings using 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 fillValue; // type anychart.graphics.vector.Fill
}. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
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:
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:
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:
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:
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:
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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
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:
Setter for series falling 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Setter for falling stroke settings.
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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
getExcludedPoints
Returns an array of excluded points.
Returns:
Array.<anychart.core.Point> - Array of the points.Try it:
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.Try it:
getPoint
Gets wrapped point by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Point index. |
Returns:
anychart.core.SeriesPoint - Wrapped point.Try it:
height
Getter for element height setting.
Returns:
number | string | undefined - Current element's height setting.Sets element height setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Height setting for the element. |
Returns:
anychart.core.cartesian.series.Candlestick - Returns self for method chaining.Try it:
hover
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:
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:
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:
hoverFallingFill
Getter for the falling 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 - Hover falling fill color.Try it:
Setter for falling fill settings in hover mode using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Falling fill color in hover mode 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:
Linear gradient falling fill in hover mode.
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:
Radial gradient falling fill in hover mode.
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:
Image falling fill in hover mode.
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:
hoverFallingHatchFill
Getter for 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 - Hover falling hatch fill settings.Try it:
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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
hoverFallingStroke
Getter for falling 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 - Falling stroke settings.Try it:
Setter for series falling stroke in hover mode by function.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| strokeFunction | 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Setter for falling stroke in hover mode settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
hoverLabels
Gets the current series hover data labels.
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
Sets the series hover data labels.
Detailed description
Sets series hover labels settings depending on parameter type:
- null/boolean - disable or enable chart hover labels.
- object - sets chart hover labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Series data labels settings. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.hoverMarkers
Getter for series data markers in hover mode.
Returns:
anychart.core.ui.MarkersFactory - Markers instance.Try it:
Setter for series data markers in hover mode.
Detailed description
Sets series markers settings on hover depending on parameter type:
- null/boolean - disable or enable series markers on hover.
- object - sets series markers settings on hover.
- string - sets series markers type on hover.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | string | false | Series data markers settings. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.hoverRisingFill
Getter for the 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 - Hover rising fill color.Try it:
Setter for rising fill settings in hover 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Setter for rising fill settings in hover mode using 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 fillValue; // type anychart.graphics.vector.Fill
}. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Rising fill color in hover mode 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:
Linear gradient rising fill in hover mode.
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:
Radial gradient rising fill in hover mode.
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:
Image rising fill in hover mode.
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:
hoverRisingHatchFill
Getter for 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 - Hover rising hatch fill settings.Try it:
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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
hoverRisingStroke
Getter for 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 - Rising stroke settings.Try it:
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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
id
Getter for the current series id.
Returns:
string | number - The current series id.Try it:
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 |
|---|---|---|
| value | 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:
includeAllPoints
Includes all excluded points.
Returns:
boolean - Returns true if all points were included.Try it:
includePoint
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:
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:
| Name | Type | Description |
|---|---|---|
| value | boolean | null | Whether to change the series layout direction to vertical. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
keepOnlyPoints
Keep only the specified points.
Params:
| Name | Type | Description |
|---|---|---|
| indexes | number | Array.<number> | Point index or indexes. |
Try it:
labels
Getter for the current series data labels.
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
Setter for the 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 | Description |
|---|---|---|
| value | Object | boolean | null | Series data labels settings. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.left
Getter for element left bound setting.
Returns:
number | string | undefined - Current element's left bound setting.Sets element left bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.core.cartesian.series.Candlestick - Returns self for method chaining.Try it:
legendItem
Gets the current legend item setting for series.
Returns:
anychart.core.utils.LegendItemSettings - Legend item settings.Try it:
Sets the legend item setting for series.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Legend item settings object. |
Returns:
anychart.core.cartesian.series.Candlestick - Legend item settings or self for chaining.Try it:
listen
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.
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:
listenOnce
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).
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:
markers
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 |
|---|---|---|---|
| value | Object | boolean | null | string | false | Series data markers settings. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.maxHeight
Getter for maximum height.
Returns:
number | string | null - Current element's maximum height.Setter for maximum height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
maxWidth
Getter for maximum width.
Returns:
number | string | null - Current element's maximum width.Setter for maximum width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
meta
Gets series meta data.
Params:
| Name | Type | Description |
|---|---|---|
| key | * | Metadata key. |
Returns:
* - Metadata object, key value or itself for method chaining.Try it:
Sets series meta data using object.
Params:
| Name | Type | Description |
|---|---|---|
| object | * | Object to replace metadata. |
| value | * | Meta data value. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Sets series meta data using key.
Params:
| Name | Type | Description |
|---|---|---|
| key | * | Metadata key. |
| value | * | Meta data value. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
minHeight
Getter for minimum height.
Returns:
number | string | null - Current element's minimum height.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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
minWidth
Getter for minimum width.
Returns:
number | string | null - Current element's minimum width.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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
name
Getter for the current series name.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
string | undefined - The current series name value.Try it:
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 |
|---|---|---|
| value | string | Value to set. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
pointWidth
Getter for the point width settings.
Returns:
string | number - The point width pixel value.Try it:
Setter for the point width settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | "90%" | Point width pixel value. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
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:
removeAllListeners
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:
rendering
Getter for the series rendering.
Returns:
anychart.core.series.RenderingSettings - Rendering settings.Try it:
Setter for the series rendering settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | function | Value to set. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
right
Getter for element right bound setting.
Returns:
number | string | undefined - Current element's right bound setting.Sets element right bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.core.cartesian.series.Candlestick - Returns self for method chaining.Try it:
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:
Setter for rising fill settings 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Setter for rising fill settings using 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 fillValue; // type anychart.graphics.vector.Fill
}. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
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:
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:
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:
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:
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:
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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
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:
Setter for series rising stroke by function.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| strokeFunction | 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
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 | 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
select
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:
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:
selectFallingFill
Getter for the 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 - Select falling fill color.Try it:
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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Setter for the falling fill settings in selected mode using 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 fillValue; // type anychart.graphics.vector.Fill
}. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Falling fill color in selected mode 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:
Linear gradient falling fill in selected mode.
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:
Radial gradient falling fill in selected mode.
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:
Image falling fill in selected mode.
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:
selectFallingHatchFill
Getter for 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 - Select falling hatch fill settings.Try it:
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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
selectFallingStroke
Getter for falling stroke 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.Stroke | function - Falling stroke settings.Try it:
Setter for series falling stroke in selected mode by function.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| strokeFunction | 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Setter for falling stroke in selected mode settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
selectLabels
Gets the current series select data labels.
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
Sets the series select data labels.
Detailed description
Setting selected labels settings depending on parameter type:
- null/boolean - disable or enable labels in selected state.
- object - sets selected labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Series data labels settings. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.selectMarkers
Getter for the series select data markers.
Returns:
anychart.core.ui.MarkersFactory - Markers instance.Try it:
Setter for series select data markers.
Detailed description
Setting selected markers settings depending on parameter type:
- null/boolean - disable or enable markers in selected state.
- object - sets selected markers settings.
- string - sets selected markers type.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | string | Series data markers settings. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.selectRisingFill
Getter for the 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 - Select rising fill color.Try it:
Setter for rising 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Setter for rising fill settings in selected mode using 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 fillValue; // type anychart.graphics.vector.Fill
}. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Rising fill color in selected mode 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:
Linear gradient rising fill in selected mode.
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:
Radial gradient rising fill in selected mode.
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:
Image rising fill in selected mode.
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:
selectRisingHatchFill
Getter for 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 - Select rising hatch fill settings.Try it:
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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
selectRisingStroke
Getter for rising stroke 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.Stroke | function - Rising stroke settings.Try it:
Setter for series rising stroke in selected 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
Setter for rising stroke settings in selected 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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
selectionMode
Gets the current state of the series for selection mode.
Returns:
anychart.enums.SelectionMode | null - Selection mode.Try it:
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:
seriesType
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.cartesian.series.Candlestick - Self instance for method chaining.Try it:
tooltip
Sets series data tooltip.
Detailed description
Sets series tooltip settings depending on parameter type:
- null/boolean - disable or enable chart tooltip.
- object - sets chart tooltip settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Tooltip settings. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.top
Getter for element top bound setting.
Returns:
number | string | undefined - Current element's top bound setting.Sets element top bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.core.cartesian.series.Candlestick - Returns self for method chaining.Try it:
transformX
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:
transformY
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:
unhover
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:
unlisten
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:
unlistenByKey
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:
unselect
Deselects all selected points.
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
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:
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:
width
Getter for element width setting.
Returns:
number | string | undefined - Current element's width setting.Sets element width setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Width setting for the element. |
Returns:
anychart.core.cartesian.series.Candlestick - Returns self for method chaining.Try it:
xPointPosition
Getter for the position of the point on an ordinal scale.
Returns:
number - X-point position.Try it:
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.
Points get a place on ordinal scale, the size of the place can be set manually.
If there are more than one seties, place size is calculated to fit all.
Points get a place on ordinal scale, the size of the place can be set manually.
If there are more than one seties, place size 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:
xScale
Setter for the series X scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.scales.Base | "ordinal" | Value to set. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
yScale
Setter for the series Y scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.scales.Base | "linear" | Value to set. |
Returns:
anychart.core.cartesian.series.Candlestick - Self instance for method chaining.Try it:
zIndex
Getter for the current Z-index of the element.
Returns:
number - The current zIndex.Try it:
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.cartesian.series.Candlestick - Self instance for method chaining.Try it: