class anychart.core.stock.series.Candlestick Improve this Doc
Extends: anychart.core.stock.series.OHLC
Candlestick Series Class.
Learn more about Candlestick series
Methods Overview
| Specific settings | |
| labels() | Labels settings. |
| legendItem() | Legend item settings. |
| maxPointWidth() | Maximum point width settings. |
| minPointLength() | Minimum point length settings. |
| pointWidth() | Point width settings. |
| Coloring | |
| colorScale() | Color scale settings. |
| fallingFill() | Falling fill settings. |
| fallingHatchFill() | Falling hatch fill settings. |
| fallingStroke() | Stroke settings. |
| risingFill() | Rising fill settings. |
| risingHatchFill() | Rising hatch fill settings. |
| risingStroke() | Stroke settings. |
| Data | |
| data() | Data settings. |
| name() | Series name settings. |
| Interactivity | |
| enabled() | Element state (enabled or disabled). |
| hovered() | Hovered state settings. |
| normal() | Normal state settings. |
| Point Elements | |
| markers() | Markers settings. |
| maxLabels() | Maximum labels settings. |
| minLabels() | Minimum labels settings. |
| tooltip() | Tooltip settings. |
| Scales | |
| yScale() | Y-scale settings. |
| Series | |
| allowPointSettings() | Allows to set point settings from data. |
| 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. |
Methods Description
allowPointSettings
Getter for the allowPointSettings flag.
Returns:
boolean - Returns allowPointSettings flag. See listing
var plot = chart.plot(); var series = plot.column(data); var allowPointSettings = series.allowPointSettings();
Setter for the allowPointSettings flag.
Detailed description
Reconfigure series by the allowPointSettings flag.
The following series support allowPointSettings flag:
Note: Other series cannot be affected by the allowPointSettings flag.
The following series support allowPointSettings flag:
- anychart.core.stock.series.Candlestick
- anychart.core.stock.series.Column
- anychart.core.stock.series.Marker
- anychart.core.stock.series.OHLC
- anychart.core.stock.series.RangeColumn
Note: Other series cannot be affected by the allowPointSettings flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Allows to set individual point settings. |
Returns:
anychart.core.stock.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:
| Name | Type | Default | Description |
|---|---|---|---|
| bottom | number | string | null | null | Bottom bound settings for the element. |
Returns:
anychart.core.stock.series.Candlestick - Returns self for method chaining.Try it:
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:
| Name | Type | Description |
|---|---|---|
| bounds | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
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.stock.series.Candlestick - Self instance for method chaining.Try it:
colorScale
Getter for the color scale.
See listing
var series = plot.line(mapping); var colorScale = series.colorScale();
Setter for the color scale.
Params:
| Name | Type | Description |
|---|---|---|
| settings | anychart.scales.LinearColor | anychart.scales.OrdinalColor | Object | anychart.enums.ScaleTypes | string | Color scale to set. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
data
Getter for data for the series.
Returns:
anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string - Returns mapping.Setter for data for the series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string | Data for the series. |
| mappingSettings | Object.<string, ({column: number, type: (anychart.enums.AggregationType|string), weights: number}|number)> | Mapping settings. An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType|string - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'. |
| csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
enabled
Getter for the element state (enabled or disabled).
Returns:
boolean - Element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
fallingFill
Getter for 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 the falling fill settings using a string, an array and object.
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.stock.series.Candlestick - Self instance for method chaining.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. See listing
var fallingHatchFill = series.fallingHatchFill();
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.stock.series.Candlestick - Self instance for method chaining.Try it:
Setter for hatch fill settings using function.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| fallingHatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
Setter for 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.stock.series.Candlestick - Self instance for method chaining.Try it:
Setter for 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.stock.series.Candlestick - Self instance for method chaining.Try it:
Setter for 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.stock.series.Candlestick - Self instance for method chaining.Try it:
fallingStroke
Getter for falling stroke settings.
Returns:
anychart.graphics.vector.Stroke - Stroke settings.Try it:
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 | '#ef6c00' | 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.stock.series.Candlestick - Self instance for method chaining.Try it:
Setter for falling stroke using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.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.height
Getter for element height settings.
Returns:
number | string | undefined - Element's height setting.Setter for element height setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Height settings for the element. |
Returns:
anychart.core.stock.series.Candlestick - Returns self for method chaining.Try it:
hovered
Getter for hovered state settings.
Returns:
anychart.core.StateSettings - Hovered state settingsTry it:
Setter for hovered state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
labels
Setter for series labels.
Detailed description
Sets series labels settings depending on parameter type:
- null/boolean - disable or enable series labels.
- object - sets series labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | true | Series labels settings. |
Returns:
anychart.core.stock.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:
| Name | Type | Default | Description |
|---|---|---|---|
| left | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.core.stock.series.Candlestick - Returns self for method chaining.Try it:
legendItem
Getter for the legend item setting for series.
Returns:
anychart.core.utils.LegendItemSettings - Legend item settings.Try it:
Setter for the legend item setting for series.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Legend item settings object. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
markers
Setter for the data markers.
Detailed description
Sets chart markers settings depending on parameter type:
- null/boolean - disable or enable chart markers.
- object - sets chart markers settings.
- string - sets chart markers type.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | string | false | Data markers settings. |
Returns:
anychart.core.stock.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:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Maximum height to set. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
maxLabels
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.stock.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 = plot.maxPointWidth();
Setter for the maximum point width.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | string | Point width pixel value. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
maxWidth
Getter for the maximum width.
Returns:
number | string | null - Element's maximum width.Setter for the maximum width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Maximum width to set. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
minHeight
Getter for the minimum height.
Returns:
number | string | null - Element's minimum 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.stock.series.Candlestick - Self instance for method chaining.Try it:
minLabels
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.stock.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 = plot.minPointLength();
Setter for the minimum point length.
Params:
| Name | Type | Description |
|---|---|---|
| length | number | string | Minimum point length pixel value. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
minWidth
Getter for the minimum width.
Returns:
number | string | null - Element's minimum 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.stock.series.Candlestick - Self instance for method chaining.Try it:
name
Setter for the series name.
Params:
| Name | Type | Description |
|---|---|---|
| name | string | Series name. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
normal
Getter for normal state settings.
Returns:
anychart.core.StateSettings - Normal state settings.Try it:
Setter for normal state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
pointWidth
Getter for point width settings.
Returns:
string | number - Point width pixel value.Try it:
Setter for the point width settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | '75%' | Point width pixel value. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.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 |
|---|---|---|
| settings | Object | function | Rendering settings to set. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
right
Getter for element right bound settings.
Returns:
number | string | undefined - Element's right bound setting.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.stock.series.Candlestick - Returns self for method chaining.Try it:
risingFill
Getter for series rising fill color.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.Fill - Rising fill color.Try it:
Setter for fill settings using a string, an array and an object.
Learn more about hatch fill settings.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an array, an object or a string. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.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. See listing
var risingHatchFill = series.risingHatchFill();
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 the hatch fill. |
| color | string | Color. | |
| thickness | number | Thickness. | |
| size | number | Pattern size. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
Setter for hatch fill settings using function.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| risingHatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
Setter for 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.stock.series.Candlestick - Self instance for method chaining.Try it:
Setter for 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.stock.series.Candlestick - Self instance for method chaining.Try it:
Setter for 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.stock.series.Candlestick - Self instance for method chaining.Try it:
risingStroke
Getter for the rising stroke settings.
Returns:
anychart.graphics.vector.Stroke - Stroke settings.Try it:
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(){
// Context:
// this.x - X value. Type is "date-time"
// this.value - value. Type is number
// this.index - point index (iterator.getIndex();). Type is number
// this.sourceColor - source color of the point.
// this.iterator - series point iterator. Type is instance of anychart.data.TableIterator
// this.plot - link to the plot. Type is instance of anychart.core.stock.Plot
// this.chart - link to the chart. Type is instance of anychart.charts.Stock
// this.name - series name. Type is string
Additional fields if colorScale () is set:
// this.scaledColor - color from this.colorScale for this point of the series. Type is string
// this.colorScale - series color scale. Type is instance of anychart.scales.LinearColor or anychart.scales.OrdinalColor
// Methods from anychart.format.Context are used for an access to series.
return strokeValue; // Type is anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
} |
Returns:
anychart.core.stock.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 | null | '#64b5f6' | 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.stock.series.Candlestick - Self instance for method chaining.Try it:
Setter for rising stroke using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.stock.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 |
|---|---|---|
| type | string | Series type. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
tooltip
Setter for the tooltip.
Detailed description
Sets series tooltip settings depending on parameter type:
- null/boolean - disable or enable series tooltip.
- object - sets series tooltip settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | true | Tooltip settings. |
Returns:
anychart.core.stock.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:
| Name | Type | Default | Description |
|---|---|---|---|
| top | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.core.stock.series.Candlestick - Returns self for method chaining.Try it:
width
Getter for element width settings.
Returns:
number | string | undefined - Element's width setting.Setter for element width setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Width settings for the element. |
Returns:
anychart.core.stock.series.Candlestick - Returns self for method chaining.Try it:
yScale
Getter for the Y-scale.
Returns:
anychart.scales.ScatterBase - Series Y-scale. See listing
var plot = chart.plot(); var plotSeries = plot.line(data); var yScale = plotSeries.yScale();
Setter for the Y-scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | anychart.scales.ScatterBase | Object | anychart.enums.ScaleTypes | string | anychart.scales.Linear | Scale settings to set. |
Returns:
anychart.core.stock.series.Candlestick - Self instance for method chaining.Try it:
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.stock.series.Candlestick - Self instance for method chaining.Try it: