Class PlotOptionsOhlc
- All Implemented Interfaces:
Serializable
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds color to the colors arrayvoidAdds key to the keys arrayvoidAdds zone to the zones arraygetClip()getColor()Color[]String[]getKeys()Zones[]getZones()voidremoveColor(Color color) Removes first occurrence of color in colors arrayvoidRemoves first occurrence of key in keys arrayvoidremoveZone(Zones zone) Removes first occurrence of zone in zones arrayvoidsetAllowPointSelect(Boolean allowPointSelect) Allow this series' points to be selected by clicking on the markers or bars.voidsetAnimation(Boolean animation) Enable or disable the initial animation when a series is displayed.voidsetAnimationLimit(Number animationLimit) For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high.voidsetClassName(String className) A class name to apply to the series' graphical elements.voidDisable this option to allow series rendering in the whole plotting area.voidThe main color of the series.voidsetColorByPoint(Boolean colorByPoint) When using automatic point colors pulled from theoptions.colorscollection, this option determines whether the chart should receive one color per series or one color per point.voidsetColorIndex(Number colorIndex) Styled mode only.voidsetColorKey(String colorKey) Determines what data value should be used to calculate point color ifcolorAxisis used.voidA series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.voidsetCompare(Compare compare) Compare the values of the series against the first non-null, non-zero value in the visible range.voidsetCompareBase(Number compareBase) When compare ispercent, this option dictates whether to use 0 or 100 as the base of comparison.voidsetCropThreshold(Number cropThreshold) When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom.voidYou can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.voidsetDataGrouping(DataGrouping dataGrouping) Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.voidsetDescription(String description) Requires Accessibility modulevoidsetEnableMouseTracking(Boolean enableMouseTracking) Enable or disable the mouse tracking for a specific series.voidsetExposeElementToA11y(Boolean exposeElementToA11y) By default, series are exposed to screen readers as regions.voidsetFindNearestPointBy(Dimension findNearestPointBy) Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.voidsetGapUnit(String gapUnit) Together withgapSize, this option defines where to draw gaps in the graph.voidsetGetExtremesFromAll(Boolean getExtremesFromAll) Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis.voidsetGrouping(Boolean grouping) Whether to group non-stacked columns or to let them render independent of each other.voidsetGroupPadding(Number groupPadding) Padding between each value groups, in x axis units.voidAn array specifying which option maps to which key in the data point array.voidsetLegendIndex(Number legendIndex) The sequential index of the series within the legend.voidsetLineWidth(Number lineWidth) The pixel width of the line/border.voidsetLinkedTo(String linkedTo) The id of another series to link to.voidsetMaxPointWidth(Number maxPointWidth) The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.voidsetMinPointLength(Number minPointLength) The minimal height for a column or width for a bar.voidsetNavigatorOptions(PlotOptionsSeries navigatorOptions) Options for the corresponding navigator series ifshowInNavigatoristruefor this series.voidsetNegativeColor(Color negativeColor) The color for the parts of the graph or points that are below the threshold.voidsetOpacity(Number opacity) Opacity of a series parts: line, fill (e.g. area) and dataLabels.voidsetPointDescriptionFormatter(String _fn_pointDescriptionFormatter) voidsetPointInterval(Number pointInterval) If no x values are given for the points in a series, pointInterval defines the interval of the x values in milliseconds.voidsetPointIntervalUnit(IntervalUnit pointIntervalUnit) On datetime series, this allows for setting the pointInterval to irregular time units,day,monthandyear.voidsetPointPadding(Number pointPadding) Padding between each column or bar, in x axis units.voidsetPointPlacement(PointPlacement pointPlacement) Possible values:null,"on","between".voidsetPointRange(Number pointRange) The width of each point on the x axis.voidsetPointStart(Number pointStart) If no x values are given for the points in a series, pointStart defines on what value to start.voidsetPointStart(Instant instant) voidsetPointWidth(Number pointWidth) A pixel value specifying a fixed width for each column or bar.voidsetSelected(Boolean selected) Whether to select the series initially.voidWhether to apply a drop shadow to the graph line.voidsetShowCheckbox(Boolean showCheckbox) If true, a checkbox is displayed next to the legend item to allow selecting the series.voidsetShowInLegend(Boolean showInLegend) Whether to display this particular series or series type in the legend.voidsetShowInNavigator(Boolean showInNavigator) Whether or not to show the series in the navigator.voidsetSkipKeyboardNavigation(Boolean skipKeyboardNavigation) If set toTrue, the accessibility module will skip past the points in this series for keyboard navigation.voidsetSoftThreshold(Boolean softThreshold) When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.voidA wrapper object for all the series options in specific states.voidsetStickyTracking(Boolean stickyTracking) Sticky tracking of mouse events.voidsetThreshold(Number threshold) The threshold, also called zero level or base level.voidsetTooltip(SeriesTooltip tooltip) A configuration object for the tooltip rendering of each single series.voidsetTurboThreshold(Number turboThreshold) When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.voidsetUpColor(Color upColor) Line color for up points.voidsetVisible(Boolean visible) Set the initial visibility of the series.voidsetZoneAxis(ZoneAxis zoneAxis) Defines the Axis on which the zones are applied.voidAn array defining zones within a series.
-
Constructor Details
-
PlotOptionsOhlc
public PlotOptionsOhlc()
-
-
Method Details
-
getChartType
- Specified by:
getChartTypein classOhlcOptions
-
getAllowPointSelect
- Specified by:
getAllowPointSelectin classOhlcOptions- See Also:
-
setAllowPointSelect
Allow this series' points to be selected by clicking on the markers or bars.Defaults to: false
- Specified by:
setAllowPointSelectin classOhlcOptions
-
getAnimation
- Specified by:
getAnimationin classOhlcOptions- See Also:
-
setAnimation
Enable or disable the initial animation when a series is displayed. Please note that this option only applies to the initial animation of the series itself. For other animations, seeChartModel.setAnimation(Boolean)- Specified by:
setAnimationin classOhlcOptions
-
getAnimationLimit
- Specified by:
getAnimationLimitin classOhlcOptions- See Also:
-
setAnimationLimit
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, setanimationLimittoInfinity.- Specified by:
setAnimationLimitin classOhlcOptions
-
getClassName
- Specified by:
getClassNamein classOhlcOptions- See Also:
-
setClassName
A class name to apply to the series' graphical elements.- Specified by:
setClassNamein classOhlcOptions
-
getClip
- Specified by:
getClipin classOhlcOptions- See Also:
-
setClip
Disable this option to allow series rendering in the whole plotting area. Note that clipping should be always enabled when chart.zoomType is setDefaults to
true.- Specified by:
setClipin classOhlcOptions
-
getColor
- See Also:
-
setColor
The main color of the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the
options.colorsarray.In styled mode, the color can be defined by the colorIndex option. Also, the series color can be set with the
.highcharts-series,.highcharts-color-{n},.highcharts-{type}-seriesor.highcharts-series-{n}class, or individual classes given by theclassNameoption. -
getColorByPoint
- Specified by:
getColorByPointin classOhlcOptions- See Also:
-
setColorByPoint
When using automatic point colors pulled from theoptions.colorscollection, this option determines whether the chart should receive one color per series or one color per point.Defaults to: false
- Specified by:
setColorByPointin classOhlcOptions
-
getColorIndex
- Specified by:
getColorIndexin classOhlcOptions- See Also:
-
setColorIndex
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class namehighcharts-color-{n}.- Specified by:
setColorIndexin classOhlcOptions
-
getColorKey
- Specified by:
getColorKeyin classOhlcOptions- See Also:
-
setColorKey
Determines what data value should be used to calculate point color ifcolorAxisis used. Requires to setminandmaxif some custom point property is used or if approximation for data grouping is set to'sum'.Defaults to
close.- Specified by:
setColorKeyin classOhlcOptions
-
getColors
- Specified by:
getColorsin classOhlcOptions- See Also:
-
setColors
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.- Specified by:
setColorsin classOhlcOptions
-
addColor
Adds color to the colors array- Specified by:
addColorin classOhlcOptions- Parameters:
color- to add- See Also:
-
removeColor
Removes first occurrence of color in colors array- Specified by:
removeColorin classOhlcOptions- Parameters:
color- to remove- See Also:
-
getCompare
- See Also:
-
setCompare
Compare the values of the series against the first non-null, non-zero value in the visible range. The y axis will show percentage or absolute change depending on whethercompareis set to"percent"or"value". When this is applied to multiple series, it allows comparing the development of the series against each other.Defaults to: undefined
-
getCompareBase
- Specified by:
getCompareBasein classOhlcOptions- See Also:
-
setCompareBase
When compare ispercent, this option dictates whether to use 0 or 100 as the base of comparison.Defaults to: 0
- Specified by:
setCompareBasein classOhlcOptions
-
getCropThreshold
- Specified by:
getCropThresholdin classOhlcOptions- See Also:
-
setCropThreshold
When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series. .Defaults to: 50
- Specified by:
setCropThresholdin classOhlcOptions
-
getCursor
- Specified by:
getCursorin classOhlcOptions- See Also:
-
setCursor
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.- Specified by:
setCursorin classOhlcOptions
-
getDataGrouping
- Specified by:
getDataGroupingin classOhlcOptions- See Also:
-
setDataGrouping
Description copied from class:OhlcOptionsData grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts. By default data grouping is applied when the points become closer than a certain pixel value, determined by the groupPixelWidth option.- Specified by:
setDataGroupingin classOhlcOptions
-
getDescription
- Specified by:
getDescriptionin classOhlcOptions- See Also:
-
setDescription
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
- Specified by:
setDescriptionin classOhlcOptions
-
getEnableMouseTracking
- Specified by:
getEnableMouseTrackingin classOhlcOptions- See Also:
-
setEnableMouseTracking
Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. When using shared tooltips (default in stock charts), mouse tracking is not required. For large datasets it improves performance.Defaults to: true
- Specified by:
setEnableMouseTrackingin classOhlcOptions
-
getExposeElementToA11y
- Specified by:
getExposeElementToA11yin classOhlcOptions- See Also:
-
setExposeElementToA11y
By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.
Requires the Accessibility module.
Defaults to: undefined
- Specified by:
setExposeElementToA11yin classOhlcOptions
-
getFindNearestPointBy
- Specified by:
getFindNearestPointByin classOhlcOptions- See Also:
-
setFindNearestPointBy
Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to
'xy'for scatter series and'x'for most other series. If the data has duplicate x-values, it is recommended to set this to'xy'to allow hovering over all points.Applies only to series types using nearest neighbor search (not direct hover) for tooltip.
- Specified by:
setFindNearestPointByin classOhlcOptions
-
getGapUnit
- Specified by:
getGapUnitin classOhlcOptions- See Also:
-
setGapUnit
Together withgapSize, this option defines where to draw gaps in the graph.Defaults to: relative
- Specified by:
setGapUnitin classOhlcOptions
-
getGetExtremesFromAll
- Specified by:
getGetExtremesFromAllin classOhlcOptions- See Also:
-
setGetExtremesFromAll
Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.Defaults to: false
- Specified by:
setGetExtremesFromAllin classOhlcOptions
-
getGroupPadding
- Specified by:
getGroupPaddingin classOhlcOptions- See Also:
-
setGroupPadding
Padding between each value groups, in x axis units.Defaults to: 0.2
- Specified by:
setGroupPaddingin classOhlcOptions
-
getGrouping
- Specified by:
getGroupingin classOhlcOptions- See Also:
-
setGrouping
Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.Defaults to: true
- Specified by:
setGroupingin classOhlcOptions
-
getKeys
- Specified by:
getKeysin classOhlcOptions- See Also:
-
setKeys
An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.- Specified by:
setKeysin classOhlcOptions
-
addKey
Adds key to the keys array- Specified by:
addKeyin classOhlcOptions- Parameters:
key- to add- See Also:
-
removeKey
Removes first occurrence of key in keys array- Specified by:
removeKeyin classOhlcOptions- Parameters:
key- to remove- See Also:
-
getLegendIndex
- Specified by:
getLegendIndexin classOhlcOptions- See Also:
-
setLegendIndex
The sequential index of the series within the legend.Defaults to: 0
- Specified by:
setLegendIndexin classOhlcOptions
-
getLineWidth
- Specified by:
getLineWidthin classOhlcOptions- See Also:
-
setLineWidth
The pixel width of the line/border. Defaults to1.Defaults to: 1
- Specified by:
setLineWidthin classOhlcOptions
-
getLinkedTo
- Specified by:
getLinkedToin classOhlcOptions- See Also:
-
setLinkedTo
The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.- Specified by:
setLinkedToin classOhlcOptions
-
getMaxPointWidth
- Specified by:
getMaxPointWidthin classOhlcOptions- See Also:
-
setMaxPointWidth
The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.Defaults to: null
- Specified by:
setMaxPointWidthin classOhlcOptions
-
getMinPointLength
- Specified by:
getMinPointLengthin classOhlcOptions- See Also:
-
setMinPointLength
The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.Defaults to: 0
- Specified by:
setMinPointLengthin classOhlcOptions
-
getOpacity
- Specified by:
getOpacityin classOhlcOptions- See Also:
-
setOpacity
Opacity of a series parts: line, fill (e.g. area) and dataLabels.Defaults to
1.- Specified by:
setOpacityin classOhlcOptions
-
getNegativeColor
- See Also:
-
setNegativeColor
The color for the parts of the graph or points that are below the threshold.Defaults to: null
-
getPointDescriptionFormatter
- Specified by:
getPointDescriptionFormatterin classOhlcOptions
-
setPointDescriptionFormatter
- Specified by:
setPointDescriptionFormatterin classOhlcOptions
-
getPointInterval
- Specified by:
getPointIntervalin classOhlcOptions- See Also:
-
setPointInterval
If no x values are given for the points in a series, pointInterval defines the interval of the x values in milliseconds. For example, if a series contains one value each day, set pointInterval to
24 * 3600 * 1000.Since Highstock 2.1, it can be combined with
pointIntervalUnitto draw irregular intervals.Defaults to: 1
- Specified by:
setPointIntervalin classOhlcOptions
-
getPointIntervalUnit
- Specified by:
getPointIntervalUnitin classOhlcOptions- See Also:
-
setPointIntervalUnit
On datetime series, this allows for setting the pointInterval to irregular time units,day,monthandyear. A day is usually the same as 24 hours, but pointIntervalUnit also takes the DST crossover into consideration when dealing with local time. Combine this option withpointIntervalto draw weeks, quarters, 6 months, 10 years etc.- Specified by:
setPointIntervalUnitin classOhlcOptions
-
getPointPadding
- Specified by:
getPointPaddingin classOhlcOptions- See Also:
-
setPointPadding
Padding between each column or bar, in x axis units.Defaults to: 0.1
- Specified by:
setPointPaddingin classOhlcOptions
-
getPointPlacement
- Specified by:
getPointPlacementin classOhlcOptions- See Also:
-
setPointPlacement
Possible values:
null,"on","between".In a column chart, when pointPlacement is
"on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is"between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.
Defaults to
nullin cartesian charts,"between"in polar charts.Defaults to: null
- Specified by:
setPointPlacementin classOhlcOptions
-
getPointRange
- Specified by:
getPointRangein classOhlcOptions- See Also:
-
setPointRange
The width of each point on the x axis. For example in a column chart with one value each day, the pointRange would be 1 day (= 24 * 3600 * 1000 milliseconds). This is normally computed automatically, but this option can be used to override the automatic value. In a series on a categorized axis the pointRange is 1 by default.Defaults to: null
- Specified by:
setPointRangein classOhlcOptions
-
getPointStart
- Specified by:
getPointStartin classOhlcOptions- See Also:
-
setPointStart
If no x values are given for the points in a series, pointStart defines on what value to start. On a datetime X axis, the number will be given as milliseconds since 1970-01-01, for exampleDate.UTC(2011, 0, 1).Defaults to: 0
- Specified by:
setPointStartin classOhlcOptions
-
getPointWidth
- Specified by:
getPointWidthin classOhlcOptions- See Also:
-
setPointWidth
A pixel value specifying a fixed width for each column or bar. Whennull, the width is calculated from thepointPaddingandgroupPadding.Defaults to: null
- Specified by:
setPointWidthin classOhlcOptions
-
getSelected
- Specified by:
getSelectedin classOhlcOptions- See Also:
-
setSelected
Whether to select the series initially. IfshowCheckboxis true, the checkbox next to the series name in the legend will be checked for a selected series.Defaults to: false
- Specified by:
setSelectedin classOhlcOptions
-
getShadow
- Specified by:
getShadowin classOhlcOptions- See Also:
-
setShadow
Whether to apply a drop shadow to the graph line. Since 1.1.7 the shadow can be an object configuration containingcolor,offsetX,offsetY,opacityandwidth.Defaults to: false
- Specified by:
setShadowin classOhlcOptions
-
getShowCheckbox
- Specified by:
getShowCheckboxin classOhlcOptions- See Also:
-
setShowCheckbox
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by theselectedoption.Defaults to: false
- Specified by:
setShowCheckboxin classOhlcOptions
-
getShowInLegend
- Specified by:
getShowInLegendin classOhlcOptions- See Also:
-
setShowInLegend
Whether to display this particular series or series type in the legend. The default value istruefor standalone series,falsefor linked series.Defaults to: true
- Specified by:
setShowInLegendin classOhlcOptions
-
getSoftThreshold
- Specified by:
getSoftThresholdin classOhlcOptions- See Also:
-
setSoftThreshold
When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
For example, if
softThresholdisfalse, a series of 0, 1, 2, 3 will make the Y axis show negative values according to theminPaddingoption. IfsoftThresholdistrue, the Y axis starts at 0.Defaults to: false
- Specified by:
setSoftThresholdin classOhlcOptions
-
getStates
- Specified by:
getStatesin classOhlcOptions- See Also:
-
setStates
A wrapper object for all the series options in specific states.- Specified by:
setStatesin classOhlcOptions
-
getStickyTracking
- Specified by:
getStickyTrackingin classOhlcOptions- See Also:
-
setStickyTracking
Sticky tracking of mouse events. When true, themouseOutevent on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOutevent on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip when not shared. WhenstickyTrackingis false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, candlesticks etc.Defaults to: true
- Specified by:
setStickyTrackingin classOhlcOptions
-
getThreshold
- Specified by:
getThresholdin classOhlcOptions- See Also:
-
setThreshold
The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.Defaults to: 0
- Specified by:
setThresholdin classOhlcOptions
-
getTooltip
- Specified by:
getTooltipin classOhlcOptions- See Also:
-
setTooltip
A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.- Specified by:
setTooltipin classOhlcOptions
-
getTurboThreshold
- Specified by:
getTurboThresholdin classOhlcOptions- See Also:
-
setTurboThreshold
When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to0disable.Defaults to: 1000
- Specified by:
setTurboThresholdin classOhlcOptions
-
getUpColor
- Specified by:
getUpColorin classOhlcOptions- See Also:
-
setUpColor
Line color for up points.- Specified by:
setUpColorin classOhlcOptions
-
getVisible
- Specified by:
getVisiblein classOhlcOptions- See Also:
-
setVisible
Set the initial visibility of the series.Defaults to: true
- Specified by:
setVisiblein classOhlcOptions
-
getZoneAxis
- Specified by:
getZoneAxisin classOhlcOptions- See Also:
-
setZoneAxis
Defines the Axis on which the zones are applied.Defaults to: y
- Specified by:
setZoneAxisin classOhlcOptions
-
getZones
- Specified by:
getZonesin classOhlcOptions- See Also:
-
setZones
An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the
zoneAxisoption.In styled mode, the color zones are styled with the
.highcharts-zone-{n}class, or custom classed from theclassNameoption (view live demo).- Specified by:
setZonesin classOhlcOptions
-
addZone
Adds zone to the zones array- Specified by:
addZonein classOhlcOptions- Parameters:
zone- to add- See Also:
-
removeZone
Removes first occurrence of zone in zones array- Specified by:
removeZonein classOhlcOptions- Parameters:
zone- to remove- See Also:
-
setPointStart
- Specified by:
setPointStartin classOhlcOptions- See Also:
-