com.vaadin.flow.component.charts.model.
Class PlotOptionsLine
All Implemented Interfaces:
See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds key to the keys array
void
Adds zone to the zones array
getClip()
getColor()
getCrisp()
String[]
getKeys()
getStep()
Zones[]
getZones()
void
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
setClassName
(String className) A class name to apply to the series' graphical elements.
void
Disable this option to allow series rendering in the whole plotting area.
void
The main color or the series.
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
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
setConnectEnds
(Boolean connectEnds) Polar charts only.
void
setConnectNulls
(Boolean connectNulls) Whether to connect a graph line across null points.
void
When true, each point or 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, even if the points fall outside the visible plot area at the current zoom.
void
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
void
setDashStyle
(DashStyle dashStyle) A name for the dash style to use for the graph.
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
setDataLabels
(DataLabels dataLabels) Options for the series data labels, appearing next to each data point.
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
setGapSize
(Number gapSize) Defines when to display a gap in the graph.
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
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
setLinecap
(String linecap) The line cap used for line ends and line joins on the graph.
void
setLineWidth
(Number lineWidth) Pixel with of the graph line.
void
setLinkedTo
(String linkedTo) The id of another series to link to.
void
Options for the point markers of line-like series.
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.
void
setPointIntervalUnit
(IntervalUnit pointIntervalUnit) On datetime series, this allows for setting the pointInterval to irregular time units,
day
,month
andyear
.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
setSelected
(Boolean selected) Whether to select the series initially.
void
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
setStacking
(Stacking stacking) Whether to stack the values of each series on top of each other.
void
A wrapper object for all the series options in specific states.
void
Whether to apply steps to the line.
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
setVisible
(Boolean visible) Set the initial visibility of the series.
void
setZoneAxis
(ZoneAxis zoneAxis) Defines the Axis on which the zones are applied.
void
An array defining zones within a series.
-
Constructor Details
-
PlotOptionsLine
public PlotOptionsLine()
-
-
Method Details
-
getChartType
Specified by:
getChartType
in classPointOptions
-
getAllowPointSelect
Specified by:
getAllowPointSelect
in classPointOptions
See Also:
-
setAllowPointSelect
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
Defaults to: false
Specified by:
setAllowPointSelect
in classPointOptions
-
getAnimation
Specified by:
getAnimation
in classPointOptions
See Also:
-
setAnimation
Enable or disable the initial animation when a series is displayed. Please note that this option only applies to the initial animation of the series itself. For other animations, see
ChartModel.setAnimation(Boolean)
Specified by:
setAnimation
in classPointOptions
-
getAnimationLimit
Specified by:
getAnimationLimit
in classPointOptions
See Also:
-
setAnimationLimit
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, set
animationLimit
toInfinity
.Specified by:
setAnimationLimit
in classPointOptions
-
getClassName
Specified by:
getClassName
in classPointOptions
See Also:
-
setClassName
A class name to apply to the series' graphical elements.
Specified by:
setClassName
in classPointOptions
-
getClip
Specified by:
getClip
in classPointOptions
See Also:
-
setClip
Disable this option to allow series rendering in the whole plotting area. Note that lipping should be always enabled when chart.zoomType is set
Defaults to
false
.Specified by:
setClip
in classPointOptions
-
getColor
Specified by:
getColor
in classPointOptions
See Also:
-
setColor
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.Specified by:
setColor
in classPointOptions
-
getColorIndex
Specified by:
getColorIndex
in classPointOptions
See Also:
-
setColorIndex
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 classPointOptions
-
getColorKey
Specified by:
getColorKey
in classPointOptions
See Also:
-
setColorKey
Determines what data value should be used to calculate point color if
colorAxis
is used. Requires to set min and max if some custom point property is used or if approximation for data grouping is set to'sum'
.Defaults to
y
.Specified by:
setColorKey
in classPointOptions
-
getCrisp
Specified by:
getCrisp
in classPointOptions
See Also:
-
setCrisp
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.Defaults to
true
.Specified by:
setCrisp
in classPointOptions
-
getConnectEnds
See Also:
-
setConnectEnds
Polar charts only. Whether to connect the ends of a line series plot across the extremes.
Defaults to: true
-
getConnectNulls
See Also:
-
setConnectNulls
Whether to connect a graph line across null points.
Defaults to: false
-
getCropThreshold
Specified by:
getCropThreshold
in classPointOptions
See Also:
-
setCropThreshold
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.
Defaults to: 300
Specified by:
setCropThreshold
in classPointOptions
-
getCursor
Specified by:
getCursor
in classPointOptions
See Also:
-
setCursor
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
Specified by:
setCursor
in classPointOptions
-
getDashStyle
Specified by:
getDashStyle
in classPointOptions
See Also:
-
setDashStyle
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
Defaults to: Solid
Specified by:
setDashStyle
in classPointOptions
-
getDataLabels
Specified by:
getDataLabels
in classPointOptions
See Also:
-
setDataLabels
Options for the series data labels, appearing next to each data point.
In styled mode, the data labels can be styled wtih the
.highcharts-data-label-box
and.highcharts-data-label
class names (see example).Specified by:
setDataLabels
in classPointOptions
-
getDescription
Specified by:
getDescription
in classPointOptions
See Also:
-
setDescription
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
Specified by:
setDescription
in classPointOptions
-
getEnableMouseTracking
Specified by:
getEnableMouseTracking
in classPointOptions
See Also:
-
setEnableMouseTracking
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 classPointOptions
-
getExposeElementToA11y
Specified by:
getExposeElementToA11y
in classPointOptions
See Also:
-
setExposeElementToA11y
By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.
Requires the Accessibility module.
Defaults to: undefined
Specified by:
setExposeElementToA11y
in classPointOptions
-
getFindNearestPointBy
Specified by:
getFindNearestPointBy
in classPointOptions
See Also:
-
setFindNearestPointBy
Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to
'xy'
for scatter series and'x'
for most other series. If the data has duplicate x-values, it is recommended to set this to'xy'
to allow hovering over all points.Applies only to series types using nearest neighbor search (not direct hover) for tooltip.
Specified by:
setFindNearestPointBy
in classPointOptions
-
getGetExtremesFromAll
Specified by:
getGetExtremesFromAll
in classPointOptions
See Also:
-
setGetExtremesFromAll
Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.
Defaults to: false
Specified by:
setGetExtremesFromAll
in classPointOptions
-
getKeys
Specified by:
getKeys
in classPointOptions
See Also:
-
setKeys
An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.
Specified by:
setKeys
in classPointOptions
-
addKey
Adds key to the keys array
Specified by:
addKey
in classPointOptions
Parameters:
key
- to addSee Also:
-
removeKey
Removes first occurrence of key in keys array
Specified by:
removeKey
in classPointOptions
Parameters:
key
- to removeSee Also:
-
getLineWidth
Specified by:
getLineWidth
in classPointOptions
See Also:
-
setLineWidth
Pixel with of the graph line.
Defaults to: 2
Specified by:
setLineWidth
in classPointOptions
-
getLinecap
See Also:
-
setLinecap
The line cap used for line ends and line joins on the graph.
Defaults to: round
-
getLinkedTo
Specified by:
getLinkedTo
in classPointOptions
See Also:
-
setLinkedTo
The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
Specified by:
setLinkedTo
in classPointOptions
-
getMarker
Specified by:
getMarker
in classPointOptions
See Also:
-
setMarker
Options for the point markers of line-like series. Properties like
fillColor
,lineColor
andlineWidth
define the visual appearance of the markers. Other series types, like column series, don't have markers, but have visual options on the series level instead.In styled mode, the markers can be styled with the
.highcharts-point
,.highcharts-point-hover
and.highcharts-point-select
class names.Specified by:
setMarker
in classPointOptions
-
getNegativeColor
Specified by:
getNegativeColor
in classPointOptions
See Also:
-
setNegativeColor
The color for the parts of the graph or points that are below the threshold.
Defaults to: null
Specified by:
setNegativeColor
in classPointOptions
-
getOpacity
Specified by:
getOpacity
in classPointOptions
See Also:
-
setOpacity
Opacity of a series parts: line, fill (e.g. area) and dataLabels.
Defaults to
1
.Specified by:
setOpacity
in classPointOptions
-
getPointDescriptionFormatter
Specified by:
getPointDescriptionFormatter
in classPointOptions
-
setPointDescriptionFormatter
Specified by:
setPointDescriptionFormatter
in classPointOptions
-
getPointInterval
Specified by:
getPointInterval
in classPointOptions
See Also:
-
setPointInterval
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 classPointOptions
-
getPointIntervalUnit
Specified by:
getPointIntervalUnit
in classPointOptions
See Also:
-
setPointIntervalUnit
On datetime series, this allows for setting the pointInterval to irregular time units,
day
,month
andyear
. A day is usually the same as 24 hours, but pointIntervalUnit also takes the DST crossover into consideration when dealing with local time. Combine this option withpointInterval
to draw weeks, quarters, 6 months, 10 years etc.Specified by:
setPointIntervalUnit
in classPointOptions
-
getPointPlacement
Specified by:
getPointPlacement
in classPointOptions
See Also:
-
setPointPlacement
Possible values:
null
,"on"
,"between"
.In a column chart, when pointPlacement is
"on"
, the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is"between"
, the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.
Defaults to
null
in cartesian charts,"between"
in polar charts.Specified by:
setPointPlacement
in classPointOptions
-
getPointStart
Specified by:
getPointStart
in classPointOptions
See Also:
-
setPointStart
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 classPointOptions
-
getSelected
Specified by:
getSelected
in classPointOptions
See Also:
-
setSelected
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 classPointOptions
-
getShadow
Specified by:
getShadow
in classPointOptions
See Also:
-
setShadow
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 classPointOptions
-
getShowCheckbox
Specified by:
getShowCheckbox
in classPointOptions
See Also:
-
setShowCheckbox
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the
selected
option.Defaults to: false
Specified by:
setShowCheckbox
in classPointOptions
-
getShowInLegend
Specified by:
getShowInLegend
in classPointOptions
See Also:
-
setShowInLegend
Whether to display this particular series or series type in the legend. The default value is
true
for standalone series,false
for linked series.Defaults to: true
Specified by:
setShowInLegend
in classPointOptions
-
getSoftThreshold
Specified by:
getSoftThreshold
in classPointOptions
See Also:
-
setSoftThreshold
When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
For example, if
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: true
Specified by:
setSoftThreshold
in classPointOptions
-
getStacking
Specified by:
getStacking
in classPointOptions
See Also:
-
setStacking
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". When stacking is enabled, data must be sorted in ascending X order.
Specified by:
setStacking
in classPointOptions
-
getStates
Specified by:
getStates
in classPointOptions
See Also:
-
setStates
A wrapper object for all the series options in specific states.
Specified by:
setStates
in classPointOptions
-
getStep
See Also:
-
setStep
Whether to apply steps to the line. Possible values are
left
,center
andright
. Prior to 2.3.5, onlyleft
was supported.Defaults to: false
-
getStickyTracking
Specified by:
getStickyTracking
in classPointOptions
See Also:
-
setStickyTracking
Sticky tracking of mouse events. When true, the
mouseOut
event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOut
event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. 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 classPointOptions
-
getThreshold
Specified by:
getThreshold
in classPointOptions
See Also:
-
setThreshold
The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.
Defaults to: 0
Specified by:
setThreshold
in classPointOptions
-
getTooltip
Specified by:
getTooltip
in classPointOptions
See Also:
-
setTooltip
A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
Specified by:
setTooltip
in classPointOptions
-
getTurboThreshold
Specified by:
getTurboThreshold
in classPointOptions
See Also:
-
setTurboThreshold
When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to
0
disable.Defaults to: 1000
Specified by:
setTurboThreshold
in classPointOptions
-
getVisible
Specified by:
getVisible
in classPointOptions
See Also:
-
setVisible
Set the initial visibility of the series.
Defaults to: true
Specified by:
setVisible
in classPointOptions
-
getZoneAxis
Specified by:
getZoneAxis
in classPointOptions
See Also:
-
setZoneAxis
Defines the Axis on which the zones are applied.
Defaults to: y
Specified by:
setZoneAxis
in classPointOptions
-
getZones
Specified by:
getZones
in classPointOptions
See Also:
-
setZones
An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the
zoneAxis
option.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 classPointOptions
-
addZone
Adds zone to the zones array
Specified by:
addZone
in classPointOptions
Parameters:
zone
- to addSee Also:
-
removeZone
Removes first occurrence of zone in zones array
Specified by:
removeZone
in classPointOptions
Parameters:
zone
- to removeSee Also:
-
getCompare
Specified by:
getCompare
in classPointOptions
See Also:
-
setCompare
Compare the values of the series against the first non-null, non-zero value in the visible range. The y axis will show percentage or absolute change depending on 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
Specified by:
setCompare
in classPointOptions
-
getCompareBase
Specified by:
getCompareBase
in classPointOptions
See Also:
-
setCompareBase
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 classPointOptions
-
getDataGrouping
Specified by:
getDataGrouping
in classPointOptions
See Also:
-
setDataGrouping
Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts. Highstock by default applies data grouping when the points become closer than a certain pixel value, determined by the
groupPixelWidth
option.If data grouping is applied, the grouping information of grouped points can be read from the Point.dataGroup.
Specified by:
setDataGrouping
in classPointOptions
-
getGapSize
See Also:
-
setGapSize
Defines when to display a gap in the graph. A gap size of 5 means that if the distance between two points is greater than five times that of the two closest points, the graph will be broken.
In practice, this option is most often used to visualize gaps in time series. In a stock chart, intraday data is available for daytime hours, while gaps will appear in nights and weekends.
Defaults to: 0
-
getGapUnit
Specified by:
getGapUnit
in classPointOptions
See Also:
-
setGapUnit
Together with
gapSize
, this option defines where to draw gaps in the graph.Defaults to: relative
Specified by:
setGapUnit
in classPointOptions
-
getLegendIndex
Specified by:
getLegendIndex
in classPointOptions
See Also:
-
setLegendIndex
The sequential index of the series within the legend.
Defaults to: 0
Specified by:
setLegendIndex
in classPointOptions
-
getPointRange
Specified by:
getPointRange
in classPointOptions
See Also:
-
setPointRange
The width of each point on the x axis. For example in a column chart with one value each day, the pointRange would be 1 day (= 24 * 3600 * 1000 milliseconds). This is normally computed automatically, but this option can be used to override the automatic value.
Defaults to: 0
Specified by:
setPointRange
in classPointOptions
-
setPointStart
Deprecated.as of 4.0. UsesetPointStart(Instant)
Specified by:
setPointStart
in classPointOptions
See Also:
-
setPointStart
Specified by:
setPointStart
in classPointOptions
See Also:
-