com.vaadin.flow.component.charts.model.
Class PointOptions
- java.lang.Object
-
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
-
- com.vaadin.flow.component.charts.model.AbstractPlotOptions
-
- com.vaadin.flow.component.charts.model.PointOptions
-
All Implemented Interfaces:
Direct Known Subclasses:
public abstract class PointOptions extends AbstractPlotOptions
See Also:
-
-
Constructor Summary
Constructors Constructor Description PointOptions()
-
Method Summary
All Methods Modifier and Type Method Description abstract void
addKey(String key)
Adds key to the keys array
abstract void
addZone(Zones zone)
Adds zone to the zones array
abstract Boolean
getAllowPointSelect()
abstract Boolean
getAnimation()
abstract Number
getAnimationLimit()
abstract ChartType
getChartType()
abstract String
getClassName()
abstract Boolean
getClip()
abstract Color
getColor()
abstract Number
getColorIndex()
abstract String
getColorKey()
abstract Compare
getCompare()
abstract Number
getCompareBase()
abstract Boolean
getCrisp()
abstract Number
getCropThreshold()
abstract Cursor
getCursor()
abstract DashStyle
getDashStyle()
abstract DataGrouping
getDataGrouping()
abstract DataLabels
getDataLabels()
abstract String
getDescription()
abstract Boolean
getEnableMouseTracking()
abstract Boolean
getExposeElementToA11y()
abstract Dimension
getFindNearestPointBy()
abstract String
getGapUnit()
abstract Boolean
getGetExtremesFromAll()
abstract String[]
getKeys()
abstract Number
getLegendIndex()
abstract Number
getLineWidth()
abstract String
getLinkedTo()
abstract Marker
getMarker()
abstract PlotOptionsSeries
getNavigatorOptions()
abstract Color
getNegativeColor()
abstract Number
getOpacity()
abstract String
getPointDescriptionFormatter()
abstract Number
getPointInterval()
abstract IntervalUnit
getPointIntervalUnit()
abstract PointPlacement
getPointPlacement()
abstract Number
getPointRange()
abstract Number
getPointStart()
abstract Boolean
getSelected()
abstract Boolean
getShadow()
abstract Boolean
getShowCheckbox()
abstract Boolean
getShowInLegend()
abstract Boolean
getShowInNavigator()
abstract Boolean
getSkipKeyboardNavigation()
abstract Boolean
getSoftThreshold()
abstract Stacking
getStacking()
abstract States
getStates()
abstract Boolean
getStickyTracking()
abstract Number
getThreshold()
abstract SeriesTooltip
getTooltip()
abstract Number
getTurboThreshold()
abstract Boolean
getVisible()
abstract ZoneAxis
getZoneAxis()
abstract Zones[]
getZones()
abstract void
removeKey(String key)
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, bars or pie slices.
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
setClip(Boolean clip)
Disable this option to allow series rendering in the whole plotting area.
abstract void
setColor(Color color)
The main color or the series.
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
setCompare(Compare compare)
Compare the values of the series against the first non-null, non-zero value in the visible range.
abstract void
setCompareBase(Number compareBase)
This option dictates whether to use 0 or 100 as the base of comparison.
abstract void
setCrisp(Boolean crisp)
When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen.
abstract void
setCropThreshold(Number cropThreshold)
When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom.
abstract 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.
abstract void
setDashStyle(DashStyle dashStyle)
A name for the dash style to use for the graph.
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 charts.
abstract void
setDataLabels(DataLabels dataLabels)
Specific data labels configuration for a series type
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
setKeys(String... keys)
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 width of the line connecting the data points.
abstract void
setLinkedTo(String linkedTo)
The ID of another series to link to.
abstract void
setMarker(Marker marker)
Options for the point markers of line-like series.
abstract void
setNavigatorOptions(PlotOptionsSeries navigatorOptions)
Options for the corresponding navigator series if
showInNavigator
istrue
for this series.abstract void
setNegativeColor(Color negativeColor)
The color for the parts of the graph or points that are below the threshold.
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.
abstract void
setPointIntervalUnit(IntervalUnit pointIntervalUnit)
On datetime series, this allows for setting the pointInterval to irregular time units,
day
,month
andyear
.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.
abstract void
setSelected(Boolean selected)
Whether to select the series initially.
abstract void
setShadow(Boolean shadow)
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
setStacking(Stacking stacking)
Whether to stack the values of each series on top of each other.
abstract void
setStates(States states)
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
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
setZones(Zones... zones)
An array defining zones within a series.
-
-
-
Method Detail
-
getChartType
public abstract ChartType getChartType()
Overrides:
getChartType
in classAbstractPlotOptions
-
getAllowPointSelect
public abstract Boolean getAllowPointSelect()
See Also:
-
setAllowPointSelect
public abstract void setAllowPointSelect(Boolean allowPointSelect)
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
-
getAnimation
public abstract Boolean getAnimation()
See Also:
-
setAnimation
public abstract void setAnimation(Boolean animation)
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.
-
getColor
public abstract Color getColor()
See Also:
-
setColor
public abstract 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.
-
getAnimationLimit
public abstract Number getAnimationLimit()
See Also:
-
setAnimationLimit
public 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. 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
public abstract String getClassName()
See Also:
-
setClassName
public abstract void setClassName(String className)
A class name to apply to the series' graphical elements.
-
getClip
public abstract Boolean getClip()
See Also:
-
setClip
public abstract 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
-
getColorIndex
public abstract Number getColorIndex()
See Also:
-
setColorIndex
public 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}
.
-
getColorKey
public abstract String getColorKey()
-
setColorKey
public abstract 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'
.
-
getCrisp
public abstract Boolean getCrisp()
See Also:
-
setCrisp
public abstract void setCrisp(Boolean crisp)
When true, each point or 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.
-
getCropThreshold
public abstract Number getCropThreshold()
See Also:
-
setCropThreshold
public abstract void setCropThreshold(Number cropThreshold)
When the series contains less points than the crop threshold, all points are drawn, even 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
public abstract Cursor getCursor()
See Also:
-
setCursor
public abstract 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.
-
getDescription
public abstract String getDescription()
See Also:
-
setDescription
public abstract void setDescription(String description)
A description of the series to add to the screen reader information about the series.
-
getDashStyle
public abstract DashStyle getDashStyle()
See Also:
-
setDashStyle
public abstract void setDashStyle(DashStyle dashStyle)
A name for the dash style to use for the graph. Applies only to series type having a graph, like
line
,spline
,area
andscatter
in case it has alineWidth
. The value for thedashStyle
include:- Solid
- ShortDash
- ShortDot
- ShortDashDot
- ShortDashDotDot
- Dot
- Dash
- LongDash
- DashDot
- LongDashDot
- LongDashDotDot
-
getDataLabels
public abstract DataLabels getDataLabels()
See Also:
-
setDataLabels
public abstract void setDataLabels(DataLabels dataLabels)
Specific data labels configuration for a series type
Parameters:
dataLabels
-
-
getEnableMouseTracking
public abstract Boolean getEnableMouseTracking()
See Also:
-
setEnableMouseTracking
public abstract 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.
-
getExposeElementToA11y
public abstract Boolean getExposeElementToA11y()
See Also:
-
setExposeElementToA11y
public abstract 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.
-
getFindNearestPointBy
public abstract Dimension getFindNearestPointBy()
See Also:
-
setFindNearestPointBy
public 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. 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 abstract Boolean getGetExtremesFromAll()
See Also:
-
setGetExtremesFromAll
public 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. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.
-
getKeys
public abstract String[] getKeys()
See Also:
-
setKeys
public abstract 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.
-
addKey
public abstract void addKey(String key)
Adds key to the keys array
Parameters:
key
- to addSee Also:
-
removeKey
public abstract void removeKey(String key)
Removes first occurrence of key in keys array
Parameters:
key
- to removeSee Also:
-
getLineWidth
public abstract Number getLineWidth()
See Also:
-
setLineWidth
public abstract void setLineWidth(Number lineWidth)
The width of the line connecting the data points.
-
getLinkedTo
public abstract String getLinkedTo()
See Also:
-
setLinkedTo
public abstract 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.
-
getMarker
public abstract Marker getMarker()
See Also:
-
setMarker
public abstract void setMarker(Marker marker)
Options for the point markers of line-like series.
-
getNegativeColor
public abstract Color getNegativeColor()
See Also:
-
setNegativeColor
public abstract void setNegativeColor(Color negativeColor)
The color for the parts of the graph or points that are below the threshold.
-
getOpacity
public abstract Number getOpacity()
See Also:
-
setOpacity
public abstract void setOpacity(Number opacity)
Opacity of a series parts: line, fill (e.g. area) and dataLabels.
-
getPointDescriptionFormatter
public abstract String getPointDescriptionFormatter()
-
setPointDescriptionFormatter
public abstract void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
-
getPointInterval
public abstract Number getPointInterval()
See Also:
-
setPointInterval
public 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. For example, if a series contains one value every decade starting from year 0, set pointInterval to 10.
It can be combined with
pointIntervalUnit
to draw irregular intervals.
-
getPointIntervalUnit
public abstract IntervalUnit getPointIntervalUnit()
See Also:
-
setPointIntervalUnit
public abstract 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.
-
getPointStart
public abstract Number getPointStart()
See Also:
-
setPointStart
public abstract 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.
-
getSelected
public abstract Boolean getSelected()
See Also:
-
setSelected
public abstract 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.
-
getShadow
public abstract Boolean getShadow()
See Also:
-
setShadow
public abstract void setShadow(Boolean shadow)
Whether to apply a drop shadow to the graph line.
-
getShowCheckbox
public abstract Boolean getShowCheckbox()
See Also:
-
setShowCheckbox
public abstract 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.
-
getShowInLegend
public abstract Boolean getShowInLegend()
See Also:
-
setShowInLegend
public abstract 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.
-
getSkipKeyboardNavigation
public abstract Boolean getSkipKeyboardNavigation()
See Also:
-
setSkipKeyboardNavigation
public abstract void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
Whether or not to skip past the points in this series for keyboard navigation.
-
getSoftThreshold
public abstract Boolean getSoftThreshold()
See Also:
-
setSoftThreshold
public 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.
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
public abstract States getStates()
See Also:
-
setStates
public abstract void setStates(States states)
A wrapper object for all the series options in specific states.
-
getStickyTracking
public abstract Boolean getStickyTracking()
See Also:
-
setStickyTracking
public abstract 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.
-
getThreshold
public abstract Number getThreshold()
See Also:
-
setThreshold
public abstract 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.
-
getTooltip
public abstract SeriesTooltip getTooltip()
See Also:
-
setTooltip
public abstract void setTooltip(SeriesTooltip tooltip)
A configuration object for the tooltip rendering of each single series.
-
getTurboThreshold
public abstract Number getTurboThreshold()
See Also:
-
setTurboThreshold
public 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. 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.
-
getVisible
public abstract Boolean getVisible()
See Also:
-
setVisible
public abstract void setVisible(Boolean visible)
Set the initial visibility of the series.
-
getZoneAxis
public abstract ZoneAxis getZoneAxis()
See Also:
-
setZoneAxis
public abstract void setZoneAxis(ZoneAxis zoneAxis)
Defines the Axis on which the zones are applied.
-
getZones
public abstract Zones[] getZones()
See Also:
-
setZones
public abstract 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.
-
addZone
public abstract void addZone(Zones zone)
Adds zone to the zones array
Parameters:
zone
- to addSee Also:
-
removeZone
public abstract void removeZone(Zones zone)
Removes first occurrence of zone in zones array
Parameters:
zone
- to removeSee Also:
-
getCompare
public abstract Compare getCompare()
See Also:
-
setCompare
public abstract 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.
-
getCompareBase
public abstract Number getCompareBase()
See Also:
-
setCompareBase
public abstract void setCompareBase(Number compareBase)
This option dictates whether to use 0 or 100 as the base of comparison.
-
getDataGrouping
public abstract DataGrouping getDataGrouping()
See Also:
-
setDataGrouping
public 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 charts.
-
getGapUnit
public abstract String getGapUnit()
See Also:
-
setGapUnit
public abstract void setGapUnit(String gapUnit)
Together with
gapSize
, this option defines where to draw gaps in the graph.
-
getLegendIndex
public abstract Number getLegendIndex()
See Also:
-
setLegendIndex
public abstract void setLegendIndex(Number legendIndex)
The sequential index of the series within the legend.
-
getNavigatorOptions
public abstract PlotOptionsSeries getNavigatorOptions()
See Also:
-
setNavigatorOptions
public abstract void setNavigatorOptions(PlotOptionsSeries navigatorOptions)
Options for the corresponding navigator series if
showInNavigator
istrue
for this series.
-
getPointPlacement
public abstract PointPlacement getPointPlacement()
See Also:
-
setPointPlacement
public abstract 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.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
public abstract Number getPointRange()
See Also:
-
setPointRange
public abstract 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.
-
getShowInNavigator
public abstract Boolean getShowInNavigator()
See Also:
-
setShowInNavigator
public abstract void setShowInNavigator(Boolean showInNavigator)
Whether or not to show the series in the navigator.
-
getStacking
public abstract Stacking getStacking()
See Also:
-
setStacking
public abstract void setStacking(Stacking stacking)
Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent".
-
setPointStart
@Deprecated public abstract void setPointStart(Date date)
Deprecated.See Also:
-
setPointStart
public abstract void setPointStart(Instant instant)
See Also:
-
-