com.vaadin.flow.component.charts.model.
Class OhlcOptions
All Implemented Interfaces:
Direct Known Subclasses:
See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract void
Adds color to the colors array
abstract void
Adds key to the keys array
abstract void
Adds zone to the zones array
abstract Boolean
abstract Boolean
abstract Number
abstract ChartType
abstract String
abstract Boolean
getClip()
abstract Boolean
abstract Number
abstract String
abstract Color[]
abstract Number
abstract Number
abstract Cursor
abstract DataGrouping
abstract String
abstract Boolean
abstract Boolean
abstract Dimension
abstract String
abstract Boolean
abstract Boolean
abstract Number
abstract String[]
getKeys()
abstract Number
abstract Number
abstract String
abstract Number
abstract Number
abstract PlotOptionsSeries
abstract Number
abstract String
abstract Number
abstract IntervalUnit
abstract Number
abstract PointPlacement
abstract Number
abstract Number
abstract Number
abstract Boolean
abstract Boolean
abstract Boolean
abstract Boolean
abstract Boolean
abstract Boolean
abstract Boolean
abstract States
abstract Boolean
abstract Number
abstract SeriesTooltip
abstract Number
abstract Color
abstract Boolean
abstract ZoneAxis
abstract Zones[]
getZones()
abstract void
removeColor
(Color color) Removes first occurrence of color in colors array
abstract void
Removes first occurrence of key in keys array
abstract void
removeZone
(Zones zone) Removes first occurrence of zone in zones array
abstract void
setAllowPointSelect
(Boolean allowPointSelect) Allow this series' points to be selected by clicking on the markers or bars.
abstract void
setAnimation
(Boolean animation) Enable or disable the initial animation when a series is displayed.
abstract void
setAnimationLimit
(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.
abstract void
setClassName
(String className) A class name to apply to the series' graphical elements.
abstract void
Disable this option to allow series rendering in the whole plotting area.
abstract void
setColorByPoint
(Boolean colorByPoint) When using automatic point colors pulled from the global colors or series-specific plotOptions.column.colors collections, this option determines whether the chart should receive one color per series or one color per point.
abstract void
setColorIndex
(Number colorIndex) A specific color index to use for the series, so its graphic representations are given the class name
highcharts-color-{n}
.abstract void
setColorKey
(String colorKey) Determines what data value should be used to calculate point color if
colorAxis
is used.abstract void
A series specific or series type specific color set to apply instead of the theme colors.
abstract void
setCompareBase
(Number compareBase) This option dictates whether to use 0 or 100 as the base of comparison.
abstract void
setCropThreshold
(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.
abstract void
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.
abstract void
setDataGrouping
(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.
abstract void
setDescription
(String description) A description of the series to add to the screen reader information about the series.
abstract void
setEnableMouseTracking
(Boolean enableMouseTracking) Enable or disable the mouse tracking for a specific series.
abstract void
setExposeElementToA11y
(Boolean exposeElementToA11y) By default, series are exposed to screen readers as regions.
abstract void
setFindNearestPointBy
(Dimension findNearestPointBy) Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.
abstract void
setGapUnit
(String gapUnit) Together with
gapSize
, this option defines where to draw gaps in the graph.abstract void
setGetExtremesFromAll
(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.
abstract void
setGrouping
(Boolean grouping) Whether to group non-stacked columns or to let them render independent of each other.
abstract void
setGroupPadding
(Number groupPadding) Padding between each value groups, in x axis units.
abstract void
An array specifying which option maps to which key in the data point array.
abstract void
setLegendIndex
(Number legendIndex) The sequential index of the series within the legend.
abstract void
setLineWidth
(Number lineWidth) The pixel width of the candlestick line/border.
abstract void
setLinkedTo
(String linkedTo) The ID of another series to link to.
abstract void
setMaxPointWidth
(Number maxPointWidth) The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.
abstract void
setMinPointLength
(Number minPointLength) The minimal height for a column or width for a bar.
abstract void
setNavigatorOptions
(PlotOptionsSeries navigatorOptions) Options for the corresponding navigator series if
showInNavigator
istrue
for this series.abstract void
setOpacity
(Number opacity) Opacity of a series parts: line, fill (e.g.
abstract void
setPointDescriptionFormatter
(String _fn_pointDescriptionFormatter) abstract void
setPointInterval
(Number pointInterval) If no x values are given for the points in a series, pointInterval defines the interval of the x values in milliseconds.
abstract void
setPointIntervalUnit
(IntervalUnit pointIntervalUnit) On datetime series, this allows for setting the pointInterval to irregular time units,
day
,month
andyear
.abstract void
setPointPadding
(Number pointPadding) Padding between each column or bar, in x axis units.
abstract void
setPointPlacement
(PointPlacement pointPlacement) Possible values:
null
,"on"
,"between"
.abstract void
setPointRange
(Number pointRange) The width of each point on the x axis.
abstract void
setPointStart
(Number pointStart) If no x values are given for the points in a series, pointStart defines on what value to start.
abstract void
setPointStart
(Instant instant) abstract void
setPointStart
(Date date) Deprecated.
as of 4.0.abstract void
setPointWidth
(Number pointWidth) A pixel value specifying a fixed width for each column or bar.
abstract void
setSelected
(Boolean selected) Whether to select the series initially.
abstract void
Whether to apply a drop shadow to the graph line.
abstract void
setShowCheckbox
(Boolean showCheckbox) If true, a checkbox is displayed next to the legend item to allow selecting the series.
abstract void
setShowInLegend
(Boolean showInLegend) Whether to display this particular series or series type in the legend.
abstract void
setShowInNavigator
(Boolean showInNavigator) Whether or not to show the series in the navigator.
abstract void
setSkipKeyboardNavigation
(Boolean skipKeyboardNavigation) Whether or not to skip past the points in this series for keyboard navigation.
abstract void
setSoftThreshold
(Boolean softThreshold) When this is true, the series will not cause the Y axis to cross the zero plane unless the data actually crosses the plane.
abstract void
A wrapper object for all the series options in specific states.
abstract void
setStickyTracking
(Boolean stickyTracking) Sticky tracking of mouse events.
abstract void
setThreshold
(Number threshold) The threshold, also called zero level or base level.
abstract void
setTooltip
(SeriesTooltip tooltip) A configuration object for the tooltip rendering of each single series.
abstract void
setTurboThreshold
(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.
abstract void
setUpColor
(Color upColor) Line color for up points.
abstract void
setVisible
(Boolean visible) Set the initial visibility of the series.
abstract void
setZoneAxis
(ZoneAxis zoneAxis) Defines the Axis on which the zones are applied.
abstract void
An array defining zones within a series.
-
Constructor Details
-
OhlcOptions
public OhlcOptions()
-
-
Method Details
-
getChartType
Overrides:
getChartType
in classAbstractPlotOptions
-
getAllowPointSelect
See Also:
-
setAllowPointSelect
Allow this series' points to be selected by clicking on the markers or bars.
-
getAnimation
See Also:
-
setAnimation
Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself.
Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
-
getAnimationLimit
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, set
animationLimit
toInfinity
. -
getClassName
See Also:
-
setClassName
A class name to apply to the series' graphical elements.
-
getClip
See Also:
-
setClip
Disable this option to allow series rendering in the whole plotting area.
-
getColorByPoint
See Also:
-
setColorByPoint
When using automatic point colors pulled from the global colors or series-specific plotOptions.column.colors collections, this option determines whether the chart should receive one color per series or one color per point.
In styled mode, the
colors
orseries.colors
arrays are not supported, and instead this option gives the points individual color class names on the formhighcharts-color-{n}
. -
getColorIndex
See Also:
-
setColorIndex
A specific color index to use for the series, so its graphic representations are given the class name
highcharts-color-{n}
. -
getColorKey
See Also:
-
setColorKey
Determines what data value should be used to calculate point color if
colorAxis
is used. Requires to setmin
andmax
if some custom point property is used or if approximation for data grouping is set to'sum'
. -
getColors
See Also:
-
setColors
A series specific or series type specific color set to apply instead of the theme colors.
-
addColor
Adds color to the colors array
Parameters:
color
- to addSee Also:
-
removeColor
Removes first occurrence of color in colors array
Parameters:
color
- to removeSee Also:
-
getCompareBase
See Also:
-
setCompareBase
This option dictates whether to use 0 or 100 as the base of comparison.
-
getCropThreshold
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. .
-
getCursor
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.
-
getDataGrouping
See Also:
-
setDataGrouping
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. By default data grouping is applied when the points become closer than a certain pixel value, determined by the groupPixelWidth option.
Parameters:
dataGrouping
- -
getDescription
See Also:
-
setDescription
A description of the series to add to the screen reader information about the series.
-
getEnableMouseTracking
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.
-
getExposeElementToA11y
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.
-
getFindNearestPointBy
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.
-
getGapUnit
See Also:
-
setGapUnit
Together with
gapSize
, this option defines where to draw gaps in the graph. -
getGetExtremesFromAll
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.
-
getGroupPadding
See Also:
-
setGroupPadding
Padding between each value groups, in x axis units.
-
getGrouping
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.
-
getKeys
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.
-
addKey
Adds key to the keys array
Parameters:
key
- to addSee Also:
-
removeKey
Removes first occurrence of key in keys array
Parameters:
key
- to removeSee Also:
-
getLegendIndex
See Also:
-
setLegendIndex
The sequential index of the series within the legend.
-
getLineWidth
See Also:
-
setLineWidth
The pixel width of the candlestick line/border.
-
getLinkedTo
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.
-
getMaxPointWidth
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.
-
getMinPointLength
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.
-
getOpacity
See Also:
-
setOpacity
Opacity of a series parts: line, fill (e.g. area) and dataLabels.
-
getPointDescriptionFormatter
-
setPointDescriptionFormatter
-
getPointInterval
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
.It can be combined with
pointIntervalUnit
to draw irregular intervals. -
getPointIntervalUnit
See Also:
-
setPointIntervalUnit
On datetime series, this allows for setting the pointInterval to irregular time units,
day
,month
andyear
. 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 withpointInterval
to draw weeks, quarters, 6 months, 10 years etc. -
getPointPadding
See Also:
-
setPointPadding
Padding between each column or bar, in x axis units.
-
getPointPlacement
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.Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.
-
getPointRange
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.
-
getPointStart
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 example
Date.UTC(2011, 0, 1)
. -
getPointWidth
See Also:
-
setPointWidth
A pixel value specifying a fixed width for each column or bar. When
null
, the width is calculated from thepointPadding
andgroupPadding
. -
getSelected
See Also:
-
setSelected
Whether to select the series initially. If
showCheckbox
is true, the checkbox next to the series name in the legend will be checked for a selected series. -
getShadow
See Also:
-
setShadow
Whether to apply a drop shadow to the graph line.
-
getShowCheckbox
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 the
selected
option. -
getShowInLegend
See Also:
-
setShowInLegend
Whether to display this particular series or series type in the legend. The default value is
true
for standalone series,false
for linked series. -
getSoftThreshold
See Also:
-
setSoftThreshold
When this is true, the series will not cause the Y axis to cross the zero plane unless the data actually crosses the plane.
For example, if
softThreshold
isfalse
, a series of 0, 1, 2, 3 will make the Y axis show negative values according to theminPadding
option. IfsoftThreshold
istrue
, the Y axis starts at 0. -
getStates
See Also:
-
setStates
A wrapper object for all the series options in specific states.
-
getStickyTracking
See Also:
-
setStickyTracking
Sticky tracking of mouse events. When true, the
mouseOut
event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOut
event 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. WhenstickyTracking
is false, the tooltip will be hidden when moving the mouse between series. -
getThreshold
See Also:
-
setThreshold
The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.
-
getTooltip
See Also:
-
setTooltip
A configuration object for the tooltip rendering of each single series.
-
getTurboThreshold
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 to
0
disable. -
getUpColor
See Also:
-
setUpColor
Line color for up points.
-
getVisible
See Also:
-
setVisible
Set the initial visibility of the series.
-
getZoneAxis
See Also:
-
setZoneAxis
Defines the Axis on which the zones are applied.
-
getZones
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
zoneAxis
option. -
addZone
Adds zone to the zones array
Parameters:
zone
- to addSee Also:
-
removeZone
Removes first occurrence of zone in zones array
Parameters:
zone
- to removeSee Also:
-
setPointStart
Deprecated.as of 4.0. UsesetPointStart(Instant)
-
setPointStart
See Also:
-