AnyChart
API Reference
Still have questions?
Contact support
Top

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

Methods Overview

Specific settings
getIndex()Gets series index.
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.
fallingStroke()Stroke 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.

Params:

NameTypeDefaultDescription
enabledboolean
false
Allows to set individual point settings.

Returns:

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

colorScale

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

Params:

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

Returns:

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

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:

NameTypeDescription
dataanychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | stringData for the series.
mappingSettingsObject.<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'.
csvSettingsObjectCSV parser settings if the string is passed.

Returns:

anychart.core.stock.series.OHLC - 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.stock.series.OHLC - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

fallingStroke

Getter for falling stroke settings.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
Setter for falling stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
'#ef6c00'
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.stock.series.OHLC - Self instance for method chaining.
Setter for falling stroke using an object.

Params:

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

Returns:

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

getIndex

Gets series index.

Returns:

number - Returns series index.

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:

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

Returns:

anychart.core.stock.series.OHLC - Returns self 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.stock.series.OHLC - Self instance for method chaining.

labels

Getter for series labels.

Returns:

anychart.core.ui.LabelsFactory - Series labels instance.
Setter for series labels.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Series labels settings.

Returns:

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

legendItem

Getter for the legend item setting for series.

Returns:

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

Params:

NameTypeDescription
settingsObjectLegend item settings object.

Returns:

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

markers

Getter for the data markers.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | boolean | null | string
false
Data markers settings.

Returns:

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

NameTypeDescription
widthnumber | stringPoint width pixel value.

Returns:

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

NameTypeDescription
lengthnumber | stringMinimum point length pixel value.

Returns:

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

name

Getter for the series name.

Returns:

string - Series name.
Setter for the series name.

Params:

NameTypeDescription
namestringSeries name.

Returns:

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

pointWidth

Getter for point width settings.

Returns:

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

Params:

NameTypeDefaultDescription
widthnumber | string | null
'75%'
Point width pixel value.

Returns:

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

risingStroke

Getter for the rising stroke settings.

Returns:

anychart.graphics.vector.Stroke - 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(){
     // 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.OHLC - 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
'#64b5f6'
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.stock.series.OHLC - Self instance for method chaining.
Setter for rising stroke using an object.

Params:

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

Returns:

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

Returns:

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

tooltip

Getter for the tooltip.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Tooltip settings.

Returns:

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

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:

NameTypeDefaultDescription
settingsanychart.scales.ScatterBase | Object | anychart.enums.ScaleTypes | string
anychart.scales.Linear
Scale settings to set.

Returns:

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