com.vaadin.flow.component.charts.model.
Class PlotOptionsColumnrange
- java.lang.Object
-
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
-
- com.vaadin.flow.component.charts.model.AbstractPlotOptions
-
- com.vaadin.flow.component.charts.model.ColumnOptions
-
- com.vaadin.flow.component.charts.model.PlotOptionsColumnrange
-
All Implemented Interfaces:
public class PlotOptionsColumnrange extends ColumnOptions
The column range is a cartesian series type with higher and lower Y values along an X axis. Requires
highcharts-more.js
. To display horizontal bars, set chart.inverted totrue
.See Also:
-
-
Constructor Summary
Constructors Constructor Description PlotOptionsColumnrange()
-
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()
Color
getBorderColor()
Number
getBorderRadius()
Number
getBorderWidth()
ChartType
getChartType()
String
getClassName()
Boolean
getClip()
Color
getColor()
Boolean
getColorByPoint()
Number
getColorIndex()
String
getColorKey()
Color[]
getColors()
Compare
getCompare()
Number
getCompareBase()
Boolean
getCrisp()
Number
getCropThreshold()
Cursor
getCursor()
DataGrouping
getDataGrouping()
DataLabelsRange
getDataLabels()
Number
getDepth()
String
getDescription()
Color
getEdgeColor()
Number
getEdgeWidth()
Boolean
getEnableMouseTracking()
Boolean
getExposeElementToA11y()
Dimension
getFindNearestPointBy()
String
getGapUnit()
Boolean
getGetExtremesFromAll()
Boolean
getGrouping()
Number
getGroupPadding()
Number
getGroupZPadding()
String[]
getKeys()
Number
getLegendIndex()
String
getLinkedTo()
Number
getMaxPointWidth()
Number
getMinPointLength()
PlotOptionsSeries
getNavigatorOptions()
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()
States
getStates()
Boolean
getStickyTracking()
SeriesTooltip
getTooltip()
Number
getTurboThreshold()
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, bars or pie slices.
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
setBorderColor(Color borderColor)
The color of the border surrounding each column or bar.
void
setBorderRadius(Number borderRadius)
The corner radius of the border surrounding each column or bar.
void
setBorderWidth(Number borderWidth)
The width of the border surrounding each column or bar.
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 or the series.
void
setColorByPoint(Boolean colorByPoint)
When using automatic point colors pulled from the
options.colors
collection, 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
setCompare(Compare compare)
Compare the values of the series against the first non-null, non-zero value in the visible range.
void
setCompareBase(Number compareBase)
When compare is
percent
, this option dictates whether to use 0 or 100 as the base of comparison.void
setCrisp(Boolean crisp)
When true, each column edge is rounded to its nearest pixel in order to render sharp on screen.
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)
void
setDataLabels(DataLabelsRange dataLabels)
Extended data labels for range series types.
void
setDepth(Number depth)
Depth of the columns in a 3D column chart.
void
setDescription(String description)
Requires Accessibility module
void
setEdgeColor(Color edgeColor)
3D columns only.
void
setEdgeWidth(Number edgeWidth)
3D columns only.
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
setGroupZPadding(Number groupZPadding)
The spacing between columns on the Z Axis in a 3D chart.
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
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
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.
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 X axis range that each point is valid for.
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
setStates(States states)
A wrapper object for all the series options in specific states.
void
setStickyTracking(Boolean stickyTracking)
Sticky tracking of mouse events.
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
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()
Overrides:
getChartType
in classAbstractPlotOptions
-
getAllowPointSelect
public Boolean getAllowPointSelect()
Specified by:
getAllowPointSelect
in classColumnOptions
See Also:
-
setAllowPointSelect
public void setAllowPointSelect(Boolean allowPointSelect)
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
Defaults to: false
Specified by:
setAllowPointSelect
in classColumnOptions
-
getAnimation
public Boolean getAnimation()
Specified by:
getAnimation
in classColumnOptions
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 classColumnOptions
-
getAnimationLimit
public Number getAnimationLimit()
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
.
-
getBorderColor
public Color getBorderColor()
Specified by:
getBorderColor
in classColumnOptions
See Also:
-
setBorderColor
public void setBorderColor(Color borderColor)
The color of the border surrounding each column or bar.
In styled mode, the border stroke can be set with the
.highcharts-point
rule.Defaults to: #ffffff
Specified by:
setBorderColor
in classColumnOptions
-
getBorderRadius
public Number getBorderRadius()
Specified by:
getBorderRadius
in classColumnOptions
See Also:
-
setBorderRadius
public void setBorderRadius(Number borderRadius)
The corner radius of the border surrounding each column or bar.
Defaults to: 0
Specified by:
setBorderRadius
in classColumnOptions
-
getBorderWidth
public Number getBorderWidth()
Specified by:
getBorderWidth
in classColumnOptions
See Also:
-
setBorderWidth
public void setBorderWidth(Number borderWidth)
The width of the border surrounding each column or bar.
In styled mode, the stroke width can be set with the
.highcharts-point
rule.Defaults to: 1
Specified by:
setBorderWidth
in classColumnOptions
-
getClip
public Boolean getClip()
Specified by:
getClip
in classColumnOptions
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 classColumnOptions
-
getClassName
public String getClassName()
See Also:
-
setClassName
public void setClassName(String className)
A class name to apply to the series' graphical elements.
-
getColor
public Color getColor()
See Also:
-
setColor
public void setColor(Color color)
The main color or 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.
-
getColorByPoint
public Boolean getColorByPoint()
Specified by:
getColorByPoint
in classColumnOptions
See Also:
-
setColorByPoint
public void setColorByPoint(Boolean colorByPoint)
When using automatic point colors pulled from the
options.colors
collection, this option determines whether the chart should receive one color per series or one color per point.Defaults to: false
Specified by:
setColorByPoint
in classColumnOptions
-
getColorKey
public String getColorKey()
Specified by:
getColorKey
in classColumnOptions
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
y
.Specified by:
setColorKey
in classColumnOptions
-
getColorIndex
public Number getColorIndex()
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}
.
-
getColors
public Color[] getColors()
Specified by:
getColors
in classColumnOptions
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 classColumnOptions
-
addColor
public void addColor(Color color)
Adds color to the colors array
Specified by:
addColor
in classColumnOptions
Parameters:
color
- to addSee Also:
-
removeColor
public void removeColor(Color color)
Removes first occurrence of color in colors array
Specified by:
removeColor
in classColumnOptions
Parameters:
color
- to removeSee Also:
-
getCrisp
public Boolean getCrisp()
Specified by:
getCrisp
in classColumnOptions
See Also:
-
setCrisp
public void setCrisp(Boolean crisp)
When true, each column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, setting
crisp
tofalse
may look better, even though each column is rendered blurry.Defaults to: true
Specified by:
setCrisp
in classColumnOptions
-
getCropThreshold
public Number getCropThreshold()
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
-
getCursor
public Cursor getCursor()
Specified by:
getCursor
in classColumnOptions
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 classColumnOptions
-
getDataLabels
public DataLabelsRange getDataLabels()
See Also:
-
setDataLabels
public void setDataLabels(DataLabelsRange dataLabels)
Extended data labels for range series types. Range series data labels have no
x
andy
options. Instead, they havexLow
,xHigh
,yLow
andyHigh
options to allow the higher and lower data label sets individually.
-
getDepth
public Number getDepth()
Specified by:
getDepth
in classColumnOptions
See Also:
-
setDepth
public void setDepth(Number depth)
Depth of the columns in a 3D column chart. Requires
highcharts-3d.js
.Defaults to: 25
Specified by:
setDepth
in classColumnOptions
-
getDescription
public String getDescription()
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
-
getEdgeColor
public Color getEdgeColor()
Specified by:
getEdgeColor
in classColumnOptions
See Also:
-
setEdgeColor
public void setEdgeColor(Color edgeColor)
3D columns only. The color of the edges. Similar to
borderColor
, except it defaults to the same color as the column.Specified by:
setEdgeColor
in classColumnOptions
-
getEdgeWidth
public Number getEdgeWidth()
Specified by:
getEdgeWidth
in classColumnOptions
See Also:
-
setEdgeWidth
public void setEdgeWidth(Number edgeWidth)
3D columns only. The width of the colored edges.
Defaults to: 1
Specified by:
setEdgeWidth
in classColumnOptions
-
getEnableMouseTracking
public Boolean getEnableMouseTracking()
Specified by:
getEnableMouseTracking
in classColumnOptions
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. For large datasets it improves performance.
Defaults to: true
Specified by:
setEnableMouseTracking
in classColumnOptions
-
getExposeElementToA11y
public Boolean getExposeElementToA11y()
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
-
getFindNearestPointBy
public Dimension getFindNearestPointBy()
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.
-
getGetExtremesFromAll
public Boolean getGetExtremesFromAll()
Specified by:
getGetExtremesFromAll
in classColumnOptions
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 classColumnOptions
-
getGroupPadding
public Number getGroupPadding()
Specified by:
getGroupPadding
in classColumnOptions
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 classColumnOptions
-
getGroupZPadding
public Number getGroupZPadding()
Specified by:
getGroupZPadding
in classColumnOptions
See Also:
-
setGroupZPadding
public void setGroupZPadding(Number groupZPadding)
The spacing between columns on the Z Axis in a 3D chart. Requires
highcharts-3d.js
.Defaults to: 1
Specified by:
setGroupZPadding
in classColumnOptions
-
getGrouping
public Boolean getGrouping()
Specified by:
getGrouping
in classColumnOptions
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 classColumnOptions
-
getKeys
public String[] getKeys()
Specified by:
getKeys
in classColumnOptions
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 classColumnOptions
-
addKey
public void addKey(String key)
Adds key to the keys array
Specified by:
addKey
in classColumnOptions
Parameters:
key
- to addSee Also:
-
removeKey
public void removeKey(String key)
Removes first occurrence of key in keys array
Specified by:
removeKey
in classColumnOptions
Parameters:
key
- to removeSee Also:
-
getLinkedTo
public String getLinkedTo()
Specified by:
getLinkedTo
in classColumnOptions
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 classColumnOptions
-
getOpacity
public Number getOpacity()
Specified by:
getOpacity
in classColumnOptions
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 classColumnOptions
-
getMaxPointWidth
public Number getMaxPointWidth()
Specified by:
getMaxPointWidth
in classColumnOptions
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 classColumnOptions
-
getMinPointLength
public Number getMinPointLength()
Specified by:
getMinPointLength
in classColumnOptions
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 classColumnOptions
-
getPointDescriptionFormatter
public String getPointDescriptionFormatter()
-
setPointDescriptionFormatter
public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
-
getPointInterval
public Number getPointInterval()
Specified by:
getPointInterval
in classColumnOptions
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. For example, if a series contains one value every decade starting from year 0, set pointInterval to 10.
Since Highcharts 4.1, it can be combined with
pointIntervalUnit
to draw irregular intervals.Defaults to: 1
Specified by:
setPointInterval
in classColumnOptions
-
getPointIntervalUnit
public IntervalUnit getPointIntervalUnit()
Specified by:
getPointIntervalUnit
in classColumnOptions
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 classColumnOptions
-
getPointPadding
public Number getPointPadding()
Specified by:
getPointPadding
in classColumnOptions
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 classColumnOptions
-
getPointPlacement
public PointPlacement getPointPlacement()
Specified by:
getPointPlacement
in classColumnOptions
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.Specified by:
setPointPlacement
in classColumnOptions
-
getPointRange
public Number getPointRange()
Specified by:
getPointRange
in classColumnOptions
See Also:
-
setPointRange
public void setPointRange(Number pointRange)
The X axis range that each point is valid for. This determines the width of the column. On a categorized axis, the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as the distance between the two closest data points.
Specified by:
setPointRange
in classColumnOptions
-
getPointStart
public Number getPointStart()
Specified by:
getPointStart
in classColumnOptions
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. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
Defaults to: 0
Specified by:
setPointStart
in classColumnOptions
-
getPointWidth
public Number getPointWidth()
Specified by:
getPointWidth
in classColumnOptions
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
.Specified by:
setPointWidth
in classColumnOptions
-
getSelected
public Boolean getSelected()
Specified by:
getSelected
in classColumnOptions
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 will be checked for a selected series.Defaults to: false
Specified by:
setSelected
in classColumnOptions
-
getShadow
public Boolean getShadow()
Specified by:
getShadow
in classColumnOptions
See Also:
-
setShadow
public void setShadow(Boolean shadow)
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing
color
,offsetX
,offsetY
,opacity
andwidth
.Defaults to: false
Specified by:
setShadow
in classColumnOptions
-
getShowCheckbox
public Boolean getShowCheckbox()
Specified by:
getShowCheckbox
in classColumnOptions
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 classColumnOptions
-
getShowInLegend
public Boolean getShowInLegend()
Specified by:
getShowInLegend
in classColumnOptions
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 classColumnOptions
-
getSkipKeyboardNavigation
public Boolean getSkipKeyboardNavigation()
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.
-
getStates
public States getStates()
Specified by:
getStates
in classColumnOptions
See Also:
-
setStates
public void setStates(States states)
A wrapper object for all the series options in specific states.
Specified by:
setStates
in classColumnOptions
-
getStickyTracking
public Boolean getStickyTracking()
Specified by:
getStickyTracking
in classColumnOptions
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. WhenstickyTracking
is false andtooltip.shared
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, pies etc.Defaults to: true
Specified by:
setStickyTracking
in classColumnOptions
-
getTooltip
public SeriesTooltip getTooltip()
Specified by:
getTooltip
in classColumnOptions
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 classColumnOptions
-
getTurboThreshold
public Number getTurboThreshold()
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
-
getVisible
public Boolean getVisible()
Specified by:
getVisible
in classColumnOptions
See Also:
-
setVisible
public void setVisible(Boolean visible)
Set the initial visibility of the series.
Defaults to: true
Specified by:
setVisible
in classColumnOptions
-
getZoneAxis
public ZoneAxis getZoneAxis()
Specified by:
getZoneAxis
in classColumnOptions
See Also:
-
setZoneAxis
public void setZoneAxis(ZoneAxis zoneAxis)
Defines the Axis on which the zones are applied.
Defaults to: y
Specified by:
setZoneAxis
in classColumnOptions
-
getZones
public Zones[] getZones()
Specified by:
getZones
in classColumnOptions
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 classColumnOptions
-
addZone
public void addZone(Zones zone)
Adds zone to the zones array
Specified by:
addZone
in classColumnOptions
Parameters:
zone
- to addSee Also:
-
removeZone
public void removeZone(Zones zone)
Removes first occurrence of zone in zones array
Specified by:
removeZone
in classColumnOptions
Parameters:
zone
- to removeSee Also:
-
getCompare
public Compare getCompare()
See Also:
-
setCompare
public void setCompare(Compare compare)
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 whether
compare
is 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
public Number getCompareBase()
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
-
getDataGrouping
public DataGrouping getDataGrouping()
See Also:
-
setDataGrouping
public void setDataGrouping(DataGrouping dataGrouping)
-
getGapUnit
public String getGapUnit()
See Also:
-
setGapUnit
public void setGapUnit(String gapUnit)
Together with
gapSize
, this option defines where to draw gaps in the graph.Defaults to: relative
-
getLegendIndex
public Number getLegendIndex()
See Also:
-
setLegendIndex
public void setLegendIndex(Number legendIndex)
The sequential index of the series within the legend.
Defaults to: 0
-
getNavigatorOptions
public PlotOptionsSeries getNavigatorOptions()
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
-
getShowInNavigator
public Boolean getShowInNavigator()
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
-
setPointStart
@Deprecated public void setPointStart(Date date)
Deprecated.as of 4.0. UsesetPointStart(Instant)
Specified by:
setPointStart
in classColumnOptions
See Also:
-
setPointStart
public void setPointStart(Instant instant)
See Also:
-
-