com.vaadin.flow.component.charts.model.
Class PlotOptionsCandlestick
- java.lang.Object
-
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
-
- com.vaadin.flow.component.charts.model.AbstractPlotOptions
-
- com.vaadin.flow.component.charts.model.OhlcOptions
-
- com.vaadin.flow.component.charts.model.PlotOptionsCandlestick
-
All Implemented Interfaces:
public class PlotOptionsCandlestick extends OhlcOptions
See Also:
-
-
Constructor Summary
Constructors Constructor Description PlotOptionsCandlestick()
-
Method Summary
All Methods Modifier and Type Method Description void
addColor(Color color)
Adds color to the colors array
void
addKey(String key)
Adds key to the keys array
void
addZone(Zones zone)
Adds zone to the zones array
Boolean
getAllowPointSelect()
Boolean
getAnimation()
Number
getAnimationLimit()
ChartType
getChartType()
String
getClassName()
Boolean
getClip()
Color
getColor()
Boolean
getColorByPoint()
Number
getColorIndex()
String
getColorKey()
Color[]
getColors()
Number
getCompareBase()
Number
getCropThreshold()
Cursor
getCursor()
DataGrouping
getDataGrouping()
String
getDescription()
Boolean
getEnableMouseTracking()
Boolean
getExposeElementToA11y()
Dimension
getFindNearestPointBy()
String
getGapUnit()
Boolean
getGetExtremesFromAll()
Boolean
getGrouping()
Number
getGroupPadding()
String[]
getKeys()
Number
getLegendIndex()
Color
getLineColor()
Number
getLineWidth()
String
getLinkedTo()
Number
getMaxPointWidth()
Number
getMinPointLength()
PlotOptionsSeries
getNavigatorOptions()
Color
getNegativeColor()
Number
getOpacity()
String
getPointDescriptionFormatter()
Number
getPointInterval()
IntervalUnit
getPointIntervalUnit()
Number
getPointPadding()
PointPlacement
getPointPlacement()
Number
getPointRange()
Number
getPointStart()
Number
getPointWidth()
Boolean
getSelected()
Boolean
getShadow()
Boolean
getShowCheckbox()
Boolean
getShowInLegend()
Boolean
getShowInNavigator()
Boolean
getSkipKeyboardNavigation()
Boolean
getSoftThreshold()
States
getStates()
Boolean
getStickyTracking()
Number
getThreshold()
SeriesTooltip
getTooltip()
Number
getTurboThreshold()
Color
getUpColor()
Color
getUpLineColor()
Boolean
getVisible()
ZoneAxis
getZoneAxis()
Zones[]
getZones()
void
removeColor(Color color)
Removes first occurrence of color in colors array
void
removeKey(String key)
Removes first occurrence of key in keys array
void
removeZone(Zones zone)
Removes first occurrence of zone in zones array
void
setAllowPointSelect(Boolean allowPointSelect)
Allow this series' points to be selected by clicking on the markers or bars.
void
setAnimation(Boolean animation)
Enable or disable the initial animation when a series is displayed.
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.
void
setClassName(String className)
A class name to apply to the series' graphical elements.
void
setClip(Boolean clip)
Disable this option to allow series rendering in the whole plotting area.
void
setColor(Color color)
The main color of the series.
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.
void
setColorIndex(Number colorIndex)
Styled mode only.
void
setColorKey(String colorKey)
Determines what data value should be used to calculate point color if
colorAxis
is used.void
setColors(Color... colors)
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
void
setCompareBase(Number compareBase)
When compare is
percent
, this option dictates whether to use 0 or 100 as the base of comparison.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.
void
setCursor(Cursor cursor)
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.
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.
void
setDescription(String description)
Requires Accessibility module
void
setEnableMouseTracking(Boolean enableMouseTracking)
Enable or disable the mouse tracking for a specific series.
void
setExposeElementToA11y(Boolean exposeElementToA11y)
By default, series are exposed to screen readers as regions.
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.
void
setGapUnit(String gapUnit)
Together with
gapSize
, this option defines where to draw gaps in the graph.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.
void
setGrouping(Boolean grouping)
Whether to group non-stacked columns or to let them render independent of each other.
void
setGroupPadding(Number groupPadding)
Padding between each value groups, in x axis units.
void
setKeys(String... keys)
An array specifying which option maps to which key in the data point array.
void
setLegendIndex(Number legendIndex)
The sequential index of the series within the legend.
void
setLineColor(Color lineColor)
The color of the line/border of the candlestick.
void
setLineWidth(Number lineWidth)
The pixel width of the candlestick line/border.
void
setLinkedTo(String linkedTo)
The id of another series to link to.
void
setMaxPointWidth(Number maxPointWidth)
The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.
void
setMinPointLength(Number minPointLength)
The minimal height for a column or width for a bar.
void
setNavigatorOptions(PlotOptionsSeries navigatorOptions)
Options for the corresponding navigator series if
showInNavigator
istrue
for this series.void
setNegativeColor(Color negativeColor)
The color for the parts of the graph or points that are below the threshold.
void
setOpacity(Number opacity)
Opacity of a series parts: line, fill (e.g.
void
setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
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.
void
setPointIntervalUnit(IntervalUnit pointIntervalUnit)
On datetime series, this allows for setting the pointInterval to irregular time units,
day
,month
andyear
.void
setPointPadding(Number pointPadding)
Padding between each column or bar, in x axis units.
void
setPointPlacement(PointPlacement pointPlacement)
Possible values:
null
,"on"
,"between"
.void
setPointRange(Number pointRange)
The width of each point on the x axis.
void
setPointStart(Number pointStart)
If no x values are given for the points in a series, pointStart defines on what value to start.
void
setPointStart(Instant instant)
void
setPointStart(Date date)
Deprecated.
as of 4.0.void
setPointWidth(Number pointWidth)
A pixel value specifying a fixed width for each column or bar.
void
setSelected(Boolean selected)
Whether to select the series initially.
void
setShadow(Boolean shadow)
Whether to apply a drop shadow to the graph line.
void
setShowCheckbox(Boolean showCheckbox)
If true, a checkbox is displayed next to the legend item to allow selecting the series.
void
setShowInLegend(Boolean showInLegend)
Whether to display this particular series or series type in the legend.
void
setShowInNavigator(Boolean showInNavigator)
Whether or not to show the series in the navigator.
void
setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
If set to
True
, the accessibility module will skip past the points in this series for keyboard navigation.void
setSoftThreshold(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.
void
setStates(States states)
A wrapper object for all the series options in specific states.
void
setStickyTracking(Boolean stickyTracking)
Sticky tracking of mouse events.
void
setThreshold(Number threshold)
The threshold, also called zero level or base level.
void
setTooltip(SeriesTooltip tooltip)
A configuration object for the tooltip rendering of each single series.
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.
void
setUpColor(Color upColor)
The fill color of the candlestick when values are rising.
void
setUpLineColor(Color upLineColor)
The specific line color for up candle sticks.
void
setVisible(Boolean visible)
Set the initial visibility of the series.
void
setZoneAxis(ZoneAxis zoneAxis)
Defines the Axis on which the zones are applied.
void
setZones(Zones... zones)
An array defining zones within a series.
-
-
-
Method Detail
-
getChartType
public ChartType getChartType()
Specified by:
getChartType
in classOhlcOptions
-
getAllowPointSelect
public Boolean getAllowPointSelect()
Specified by:
getAllowPointSelect
in classOhlcOptions
See Also:
-
setAllowPointSelect
public void setAllowPointSelect(Boolean allowPointSelect)
Allow this series' points to be selected by clicking on the markers or bars.
Defaults to: false
Specified by:
setAllowPointSelect
in classOhlcOptions
-
getAnimation
public Boolean getAnimation()
Specified by:
getAnimation
in classOhlcOptions
See Also:
-
setAnimation
public void setAnimation(Boolean animation)
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, see
ChartModel.setAnimation(Boolean)
Specified by:
setAnimation
in classOhlcOptions
-
getAnimationLimit
public Number getAnimationLimit()
Specified by:
getAnimationLimit
in classOhlcOptions
See Also:
-
setAnimationLimit
public 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. 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
.Specified by:
setAnimationLimit
in classOhlcOptions
-
getClassName
public String getClassName()
Specified by:
getClassName
in classOhlcOptions
See Also:
-
setClassName
public void setClassName(String className)
A class name to apply to the series' graphical elements.
Specified by:
setClassName
in classOhlcOptions
-
getClip
public Boolean getClip()
Specified by:
getClip
in classOhlcOptions
See Also:
-
setClip
public void setClip(Boolean clip)
Disable this option to allow series rendering in the whole plotting area. Note that clipping should be always enabled when chart.zoomType is set
Defaults to
true
.Specified by:
setClip
in classOhlcOptions
-
getColorByPoint
public Boolean getColorByPoint()
Specified by:
getColorByPoint
in classOhlcOptions
See Also:
-
setColorByPoint
public 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.
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}
.Defaults to
false
.Specified by:
setColorByPoint
in classOhlcOptions
-
getColor
public Color getColor()
See Also:
-
setColor
public void setColor(Color color)
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.colors
array.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}-series
or.highcharts-series-{n}
class, or individual classes given by theclassName
option.
-
getColorIndex
public Number getColorIndex()
Specified by:
getColorIndex
in classOhlcOptions
See Also:
-
setColorIndex
public void setColorIndex(Number colorIndex)
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name
highcharts-color-{n}
.Specified by:
setColorIndex
in classOhlcOptions
-
getColorKey
public String getColorKey()
Specified by:
getColorKey
in classOhlcOptions
See Also:
-
setColorKey
public void setColorKey(String colorKey)
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'
.Defaults to
close
.Specified by:
setColorKey
in classOhlcOptions
-
getColors
public Color[] getColors()
Specified by:
getColors
in classOhlcOptions
See Also:
-
setColors
public void setColors(Color... colors)
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
Specified by:
setColors
in classOhlcOptions
-
addColor
public void addColor(Color color)
Adds color to the colors array
Specified by:
addColor
in classOhlcOptions
Parameters:
color
- to addSee Also:
-
removeColor
public void removeColor(Color color)
Removes first occurrence of color in colors array
Specified by:
removeColor
in classOhlcOptions
Parameters:
color
- to removeSee Also:
-
getCompareBase
public Number getCompareBase()
Specified by:
getCompareBase
in classOhlcOptions
See Also:
-
setCompareBase
public void setCompareBase(Number compareBase)
When compare is
percent
, this option dictates whether to use 0 or 100 as the base of comparison.Defaults to: 0
Specified by:
setCompareBase
in classOhlcOptions
-
getCropThreshold
public Number getCropThreshold()
Specified by:
getCropThreshold
in classOhlcOptions
See Also:
-
setCropThreshold
public 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. 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:
setCropThreshold
in classOhlcOptions
-
getCursor
public Cursor getCursor()
Specified by:
getCursor
in classOhlcOptions
See Also:
-
setCursor
public void setCursor(Cursor cursor)
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:
setCursor
in classOhlcOptions
-
getDataGrouping
public DataGrouping getDataGrouping()
Specified by:
getDataGrouping
in classOhlcOptions
See Also:
-
setDataGrouping
public void setDataGrouping(DataGrouping dataGrouping)
Description copied from class:
OhlcOptions
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.
Specified by:
setDataGrouping
in classOhlcOptions
-
getDescription
public String getDescription()
Specified by:
getDescription
in classOhlcOptions
See Also:
-
setDescription
public void setDescription(String description)
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
Specified by:
setDescription
in classOhlcOptions
-
getEnableMouseTracking
public Boolean getEnableMouseTracking()
Specified by:
getEnableMouseTracking
in classOhlcOptions
See Also:
-
setEnableMouseTracking
public void setEnableMouseTracking(Boolean enableMouseTracking)
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:
setEnableMouseTracking
in classOhlcOptions
-
getExposeElementToA11y
public Boolean getExposeElementToA11y()
Specified by:
getExposeElementToA11y
in classOhlcOptions
See Also:
-
setExposeElementToA11y
public void setExposeElementToA11y(Boolean exposeElementToA11y)
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:
setExposeElementToA11y
in classOhlcOptions
-
getFindNearestPointBy
public Dimension getFindNearestPointBy()
Specified by:
getFindNearestPointBy
in classOhlcOptions
See Also:
-
setFindNearestPointBy
public 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. 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:
setFindNearestPointBy
in classOhlcOptions
-
getGapUnit
public String getGapUnit()
Specified by:
getGapUnit
in classOhlcOptions
See Also:
-
setGapUnit
public void setGapUnit(String gapUnit)
Together with
gapSize
, this option defines where to draw gaps in the graph.Defaults to: relative
Specified by:
setGapUnit
in classOhlcOptions
-
getGetExtremesFromAll
public Boolean getGetExtremesFromAll()
Specified by:
getGetExtremesFromAll
in classOhlcOptions
See Also:
-
setGetExtremesFromAll
public 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. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.
Defaults to: false
Specified by:
setGetExtremesFromAll
in classOhlcOptions
-
getGroupPadding
public Number getGroupPadding()
Specified by:
getGroupPadding
in classOhlcOptions
See Also:
-
setGroupPadding
public void setGroupPadding(Number groupPadding)
Padding between each value groups, in x axis units.
Defaults to: 0.2
Specified by:
setGroupPadding
in classOhlcOptions
-
getGrouping
public Boolean getGrouping()
Specified by:
getGrouping
in classOhlcOptions
See Also:
-
setGrouping
public void setGrouping(Boolean grouping)
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:
setGrouping
in classOhlcOptions
-
getKeys
public String[] getKeys()
Specified by:
getKeys
in classOhlcOptions
See Also:
-
setKeys
public void setKeys(String... keys)
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:
setKeys
in classOhlcOptions
-
addKey
public void addKey(String key)
Adds key to the keys array
Specified by:
addKey
in classOhlcOptions
Parameters:
key
- to addSee Also:
-
removeKey
public void removeKey(String key)
Removes first occurrence of key in keys array
Specified by:
removeKey
in classOhlcOptions
Parameters:
key
- to removeSee Also:
-
getLegendIndex
public Number getLegendIndex()
Specified by:
getLegendIndex
in classOhlcOptions
See Also:
-
setLegendIndex
public void setLegendIndex(Number legendIndex)
The sequential index of the series within the legend.
Defaults to: 0
Specified by:
setLegendIndex
in classOhlcOptions
-
getLineColor
public Color getLineColor()
See Also:
-
setLineColor
public void setLineColor(Color lineColor)
The color of the line/border of the candlestick.
In styled mode, the line stroke can be set with the
.highcharts-candlestick-series .highcahrts-point
rule.Defaults to: #000000
-
getLineWidth
public Number getLineWidth()
Specified by:
getLineWidth
in classOhlcOptions
See Also:
-
setLineWidth
public void setLineWidth(Number lineWidth)
The pixel width of the candlestick line/border. Defaults to
1
.In styled mode, the line stroke width can be set with the
.highcharts-candlestick-series .highcahrts-point
rule.Defaults to: 1
Specified by:
setLineWidth
in classOhlcOptions
-
getLinkedTo
public String getLinkedTo()
Specified by:
getLinkedTo
in classOhlcOptions
See Also:
-
setLinkedTo
public void setLinkedTo(String linkedTo)
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:
setLinkedTo
in classOhlcOptions
-
getMaxPointWidth
public Number getMaxPointWidth()
Specified by:
getMaxPointWidth
in classOhlcOptions
See Also:
-
setMaxPointWidth
public void setMaxPointWidth(Number maxPointWidth)
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:
setMaxPointWidth
in classOhlcOptions
-
getMinPointLength
public Number getMinPointLength()
Specified by:
getMinPointLength
in classOhlcOptions
See Also:
-
setMinPointLength
public void setMinPointLength(Number minPointLength)
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:
setMinPointLength
in classOhlcOptions
-
getNavigatorOptions
public PlotOptionsSeries getNavigatorOptions()
Specified by:
getNavigatorOptions
in classOhlcOptions
See Also:
-
setNavigatorOptions
public void setNavigatorOptions(PlotOptionsSeries navigatorOptions)
Options for the corresponding navigator series if
showInNavigator
istrue
for this series. Available options are the same as any series, documented at plotOptions and series.These options are merged with options in navigator.series, and will take precedence if the same option is defined both places.
Defaults to: undefined
Specified by:
setNavigatorOptions
in classOhlcOptions
-
getOpacity
public Number getOpacity()
Specified by:
getOpacity
in classOhlcOptions
See Also:
-
setOpacity
public void setOpacity(Number opacity)
Opacity of a series parts: line, fill (e.g. area) and dataLabels.
Defaults to
1
.Specified by:
setOpacity
in classOhlcOptions
-
getNegativeColor
public Color getNegativeColor()
See Also:
-
setNegativeColor
public void setNegativeColor(Color negativeColor)
The color for the parts of the graph or points that are below the threshold.
Defaults to: null
-
getPointDescriptionFormatter
public String getPointDescriptionFormatter()
Specified by:
getPointDescriptionFormatter
in classOhlcOptions
-
setPointDescriptionFormatter
public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
Specified by:
setPointDescriptionFormatter
in classOhlcOptions
-
getPointInterval
public Number getPointInterval()
Specified by:
getPointInterval
in classOhlcOptions
See Also:
-
setPointInterval
public 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. 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
pointIntervalUnit
to draw irregular intervals.Defaults to: 1
Specified by:
setPointInterval
in classOhlcOptions
-
getPointIntervalUnit
public IntervalUnit getPointIntervalUnit()
Specified by:
getPointIntervalUnit
in classOhlcOptions
See Also:
-
setPointIntervalUnit
public void setPointIntervalUnit(IntervalUnit pointIntervalUnit)
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.Specified by:
setPointIntervalUnit
in classOhlcOptions
-
getPointPadding
public Number getPointPadding()
Specified by:
getPointPadding
in classOhlcOptions
See Also:
-
setPointPadding
public void setPointPadding(Number pointPadding)
Padding between each column or bar, in x axis units.
Defaults to: 0.1
Specified by:
setPointPadding
in classOhlcOptions
-
getPointPlacement
public PointPlacement getPointPlacement()
Specified by:
getPointPlacement
in classOhlcOptions
See Also:
-
setPointPlacement
public void setPointPlacement(PointPlacement pointPlacement)
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
null
in cartesian charts,"between"
in polar charts.Defaults to: null
Specified by:
setPointPlacement
in classOhlcOptions
-
getPointRange
public Number getPointRange()
Specified by:
getPointRange
in classOhlcOptions
See Also:
-
setPointRange
public void setPointRange(Number pointRange)
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:
setPointRange
in classOhlcOptions
-
getPointStart
public Number getPointStart()
Specified by:
getPointStart
in classOhlcOptions
See Also:
-
setPointStart
public void setPointStart(Number pointStart)
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)
.Defaults to: 0
Specified by:
setPointStart
in classOhlcOptions
-
getPointWidth
public Number getPointWidth()
Specified by:
getPointWidth
in classOhlcOptions
See Also:
-
setPointWidth
public void setPointWidth(Number pointWidth)
A pixel value specifying a fixed width for each column or bar. When
null
, the width is calculated from thepointPadding
andgroupPadding
.Defaults to: null
Specified by:
setPointWidth
in classOhlcOptions
-
getSelected
public Boolean getSelected()
Specified by:
getSelected
in classOhlcOptions
See Also:
-
setSelected
public void setSelected(Boolean selected)
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.Defaults to: false
Specified by:
setSelected
in classOhlcOptions
-
getShadow
public Boolean getShadow()
Specified by:
getShadow
in classOhlcOptions
See Also:
-
setShadow
public void setShadow(Boolean shadow)
Whether to apply a drop shadow to the graph line. Since 1.1.7 the shadow can be an object configuration containing
color
,offsetX
,offsetY
,opacity
andwidth
.Defaults to: false
Specified by:
setShadow
in classOhlcOptions
-
getShowCheckbox
public Boolean getShowCheckbox()
Specified by:
getShowCheckbox
in classOhlcOptions
See Also:
-
setShowCheckbox
public void setShowCheckbox(Boolean showCheckbox)
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.Defaults to: false
Specified by:
setShowCheckbox
in classOhlcOptions
-
getShowInLegend
public Boolean getShowInLegend()
Specified by:
getShowInLegend
in classOhlcOptions
See Also:
-
setShowInLegend
public void setShowInLegend(Boolean showInLegend)
Whether to display this particular series or series type in the legend. The default value is
true
for standalone series,false
for linked series.Defaults to: true
Specified by:
setShowInLegend
in classOhlcOptions
-
getShowInNavigator
public Boolean getShowInNavigator()
Specified by:
getShowInNavigator
in classOhlcOptions
See Also:
-
setShowInNavigator
public void setShowInNavigator(Boolean showInNavigator)
Whether or not to show the series in the navigator. Takes precedence over navigator.baseSeries if defined.
Defaults to: undefined
Specified by:
setShowInNavigator
in classOhlcOptions
-
getSkipKeyboardNavigation
public Boolean getSkipKeyboardNavigation()
Specified by:
getSkipKeyboardNavigation
in classOhlcOptions
See Also:
-
setSkipKeyboardNavigation
public void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
If set to
True
, the accessibility module will skip past the points in this series for keyboard navigation.Specified by:
setSkipKeyboardNavigation
in classOhlcOptions
-
getSoftThreshold
public Boolean getSoftThreshold()
Specified by:
getSoftThreshold
in classOhlcOptions
See Also:
-
setSoftThreshold
public void setSoftThreshold(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.
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.Defaults to: false
Specified by:
setSoftThreshold
in classOhlcOptions
-
getStates
public States getStates()
Specified by:
getStates
in classOhlcOptions
See Also:
-
setStates
public void setStates(States states)
A wrapper object for all the series options in specific states.
Specified by:
setStates
in classOhlcOptions
-
getStickyTracking
public Boolean getStickyTracking()
Specified by:
getStickyTracking
in classOhlcOptions
See Also:
-
setStickyTracking
public void setStickyTracking(Boolean stickyTracking)
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. Defaults to true for line and area type series, but to false for columns, candlesticks etc.Defaults to: true
Specified by:
setStickyTracking
in classOhlcOptions
-
getThreshold
public Number getThreshold()
Specified by:
getThreshold
in classOhlcOptions
See Also:
-
setThreshold
public void setThreshold(Number threshold)
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:
setThreshold
in classOhlcOptions
-
getTooltip
public SeriesTooltip getTooltip()
Specified by:
getTooltip
in classOhlcOptions
See Also:
-
setTooltip
public void setTooltip(SeriesTooltip tooltip)
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:
setTooltip
in classOhlcOptions
-
getTurboThreshold
public Number getTurboThreshold()
Specified by:
getTurboThreshold
in classOhlcOptions
See Also:
-
setTurboThreshold
public 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. 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.Defaults to: 1000
Specified by:
setTurboThreshold
in classOhlcOptions
-
getUpColor
public Color getUpColor()
Specified by:
getUpColor
in classOhlcOptions
See Also:
-
setUpColor
public void setUpColor(Color upColor)
The fill color of the candlestick when values are rising.
In styled mode, the up color can be set with the
.highcharts-candlestick-series .highcharts-point-up
rule.Defaults to: #ffffff
Specified by:
setUpColor
in classOhlcOptions
-
getUpLineColor
public Color getUpLineColor()
See Also:
-
setUpLineColor
public void setUpLineColor(Color upLineColor)
The specific line color for up candle sticks. The default is to inherit the general
lineColor
setting.Defaults to: null
-
getVisible
public Boolean getVisible()
Specified by:
getVisible
in classOhlcOptions
See Also:
-
setVisible
public void setVisible(Boolean visible)
Set the initial visibility of the series.
Defaults to: true
Specified by:
setVisible
in classOhlcOptions
-
getZoneAxis
public ZoneAxis getZoneAxis()
Specified by:
getZoneAxis
in classOhlcOptions
See Also:
-
setZoneAxis
public void setZoneAxis(ZoneAxis zoneAxis)
Defines the Axis on which the zones are applied.
Defaults to: y
Specified by:
setZoneAxis
in classOhlcOptions
-
getZones
public Zones[] getZones()
Specified by:
getZones
in classOhlcOptions
See Also:
-
setZones
public void setZones(Zones... zones)
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.In styled mode, the color zones are styled with the
.highcharts-zone-{n}
class, or custom classed from theclassName
option (view live demo).Specified by:
setZones
in classOhlcOptions
-
addZone
public void addZone(Zones zone)
Adds zone to the zones array
Specified by:
addZone
in classOhlcOptions
Parameters:
zone
- to addSee Also:
-
removeZone
public void removeZone(Zones zone)
Removes first occurrence of zone in zones array
Specified by:
removeZone
in classOhlcOptions
Parameters:
zone
- to removeSee Also:
-
setPointStart
@Deprecated public void setPointStart(Date date)
Deprecated.as of 4.0. UsesetPointStart(Instant)
Specified by:
setPointStart
in classOhlcOptions
-
setPointStart
public void setPointStart(Instant instant)
Specified by:
setPointStart
in classOhlcOptions
See Also:
-
-