com.vaadin.flow.component.charts.model.
Class PlotOptionsWaterfall
All Implemented Interfaces:
Options for the waterfall series type.
See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds color to the colors array
void
Adds key to the keys array
void
Adds zone to the zones array
getClip()
getColor()
Color[]
getCrisp()
getDepth()
String[]
getKeys()
Zones[]
getZones()
void
removeColor
(Color color) Removes first occurrence of color in colors array
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
setBorderColor
(Color borderColor) The color of the border of each waterfall column.
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
Disable this option to allow series rendering in the whole plotting area.
void
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
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
void
When true, each column edge is rounded to its nearest pixel in order to render sharp on screen.
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 line connecting the columns of the waterfall series.
void
setDataLabels
(DataLabels dataLabels) Options for the series data labels, appearing next to each data point.
void
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
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
An array specifying which option maps to which key in the data point array.
void
setLineColor
(Color lineColor) The color of the line that connects columns in a waterfall series.
void
setLineWidth
(Number lineWidth) The width of the line connecting waterfall columns.
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
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
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
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
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 Y axis value to serve as the base for the columns, for distinguishing between values above and below a threshold.
void
setTooltip
(SeriesTooltip tooltip) A configuration object for the tooltip rendering of each single series.
void
setUpColor
(Color upColor) The color used specifically for positive point columns.
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
-
PlotOptionsWaterfall
public PlotOptionsWaterfall()
-
-
Method Details
-
getChartType
Overrides:
getChartType
in classAbstractPlotOptions
-
getAllowPointSelect
Specified by:
getAllowPointSelect
in classColumnOptions
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 classColumnOptions
-
getAnimation
Specified by:
getAnimation
in classColumnOptions
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 classColumnOptions
-
getAnimationLimit
See Also:
-
setAnimationLimit
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, set
animationLimit
toInfinity
. -
getBorderColor
Specified by:
getBorderColor
in classColumnOptions
See Also:
-
setBorderColor
The color of the border of each waterfall column.
In styled mode, the border stroke can be set with the
.highcharts-point
class.Defaults to: #333333
Specified by:
setBorderColor
in classColumnOptions
-
getBorderRadius
Specified by:
getBorderRadius
in classColumnOptions
See Also:
-
setBorderRadius
The corner radius of the border surrounding each column or bar.
Defaults to: 0
Specified by:
setBorderRadius
in classColumnOptions
-
getBorderWidth
Specified by:
getBorderWidth
in classColumnOptions
See Also:
-
setBorderWidth
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
Specified by:
getClip
in classColumnOptions
See Also:
-
setClip
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
See Also:
-
setClassName
A class name to apply to the series' graphical elements.
-
getColor
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. -
getColorByPoint
Specified by:
getColorByPoint
in classColumnOptions
See Also:
-
setColorByPoint
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
Specified by:
getColorKey
in classColumnOptions
See Also:
-
setColorKey
Determines what data value should be used to calculate point color if
colorAxis
is used. Requires to setmin
andamx
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
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}
. -
getColors
Specified by:
getColors
in classColumnOptions
See Also:
-
setColors
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
Adds color to the colors array
Specified by:
addColor
in classColumnOptions
Parameters:
color
- to addSee Also:
-
removeColor
Removes first occurrence of color in colors array
Specified by:
removeColor
in classColumnOptions
Parameters:
color
- to removeSee Also:
-
getCrisp
Specified by:
getCrisp
in classColumnOptions
See Also:
-
setCrisp
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
-
getCursor
Specified by:
getCursor
in classColumnOptions
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 classColumnOptions
-
getDashStyle
See Also:
-
setDashStyle
A name for the dash style to use for the line connecting the columns of the waterfall series. Possible values:
- Solid
- ShortDash
- ShortDot
- ShortDashDot
- ShortDashDotDot
- Dot
- Dash
- LongDash
- DashDot
- LongDashDot
- LongDashDotDot
In styled mode, the stroke dash-array can be set with the
.highcharts-graph
class.Defaults to: Dot
-
getDataLabels
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). -
getDepth
Specified by:
getDepth
in classColumnOptions
See Also:
-
setDepth
Depth of the columns in a 3D column chart. Requires
highcharts-3d.js
.Defaults to: 25
Specified by:
setDepth
in classColumnOptions
-
getDescription
See Also:
-
setDescription
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
-
getEdgeColor
Specified by:
getEdgeColor
in classColumnOptions
See Also:
-
setEdgeColor
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
Specified by:
getEdgeWidth
in classColumnOptions
See Also:
-
setEdgeWidth
3D columns only. The width of the colored edges.
Defaults to: 1
Specified by:
setEdgeWidth
in classColumnOptions
-
getEnableMouseTracking
Specified by:
getEnableMouseTracking
in classColumnOptions
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 classColumnOptions
-
getExposeElementToA11y
See Also:
-
setExposeElementToA11y
By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.
Requires the Accessibility module.
Defaults to: undefined
-
getFindNearestPointBy
See Also:
-
setFindNearestPointBy
Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to
'xy'
for scatter series and'x'
for most other series. If the data has duplicate x-values, it is recommended to set this to'xy'
to allow hovering over all points.Applies only to series types using nearest neighbor search (not direct hover) for tooltip.
-
getGetExtremesFromAll
Specified by:
getGetExtremesFromAll
in classColumnOptions
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 classColumnOptions
-
getGroupPadding
Specified by:
getGroupPadding
in classColumnOptions
See Also:
-
setGroupPadding
Padding between each value groups, in x axis units.
Defaults to: 0.2
Specified by:
setGroupPadding
in classColumnOptions
-
getGroupZPadding
Specified by:
getGroupZPadding
in classColumnOptions
See Also:
-
setGroupZPadding
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
Specified by:
getGrouping
in classColumnOptions
See Also:
-
setGrouping
Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.
Defaults to: true
Specified by:
setGrouping
in classColumnOptions
-
getKeys
Specified by:
getKeys
in classColumnOptions
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 classColumnOptions
-
addKey
Adds key to the keys array
Specified by:
addKey
in classColumnOptions
Parameters:
key
- to addSee Also:
-
removeKey
Removes first occurrence of key in keys array
Specified by:
removeKey
in classColumnOptions
Parameters:
key
- to removeSee Also:
-
getLineColor
See Also:
-
setLineColor
The color of the line that connects columns in a waterfall series.
In styled mode, the stroke can be set with the
.highcharts-graph
class.Defaults to: #333333
-
getLineWidth
See Also:
-
setLineWidth
The width of the line connecting waterfall columns.
Defaults to: 1
-
getLinkedTo
Specified by:
getLinkedTo
in classColumnOptions
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 classColumnOptions
-
getOpacity
Specified by:
getOpacity
in classColumnOptions
See Also:
-
setOpacity
Opacity of a series parts: line, fill (e.g. area) and dataLabels.
Defaults to
1
.Specified by:
setOpacity
in classColumnOptions
-
getMaxPointWidth
Specified by:
getMaxPointWidth
in classColumnOptions
See Also:
-
setMaxPointWidth
The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.
Defaults to: null
Specified by:
setMaxPointWidth
in classColumnOptions
-
getMinPointLength
Specified by:
getMinPointLength
in classColumnOptions
See Also:
-
setMinPointLength
The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.
Defaults to: 0
Specified by:
setMinPointLength
in classColumnOptions
-
getPointDescriptionFormatter
-
setPointDescriptionFormatter
-
getPointInterval
Specified by:
getPointInterval
in classColumnOptions
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 classColumnOptions
-
getPointIntervalUnit
Specified by:
getPointIntervalUnit
in classColumnOptions
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 classColumnOptions
-
getPointPadding
Specified by:
getPointPadding
in classColumnOptions
See Also:
-
setPointPadding
Padding between each column or bar, in x axis units.
Defaults to: 0.1
Specified by:
setPointPadding
in classColumnOptions
-
getPointPlacement
Specified by:
getPointPlacement
in classColumnOptions
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 classColumnOptions
-
getPointRange
Specified by:
getPointRange
in classColumnOptions
See Also:
-
setPointRange
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
Specified by:
getPointStart
in classColumnOptions
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 classColumnOptions
-
getPointWidth
Specified by:
getPointWidth
in classColumnOptions
See Also:
-
setPointWidth
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
Specified by:
getSelected
in classColumnOptions
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 classColumnOptions
-
getShadow
Specified by:
getShadow
in classColumnOptions
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 classColumnOptions
-
getShowCheckbox
Specified by:
getShowCheckbox
in classColumnOptions
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 classColumnOptions
-
getShowInLegend
Specified by:
getShowInLegend
in classColumnOptions
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 classColumnOptions
-
getSoftThreshold
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
-
getStates
Specified by:
getStates
in classColumnOptions
See Also:
-
setStates
A wrapper object for all the series options in specific states.
Specified by:
setStates
in classColumnOptions
-
getStickyTracking
Specified by:
getStickyTracking
in classColumnOptions
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 classColumnOptions
-
getThreshold
See Also:
-
setThreshold
The Y axis value to serve as the base for the columns, for distinguishing between values above and below a threshold. If
null
, the columns extend from the padding Y axis minimum.Defaults to: 0
-
getTooltip
Specified by:
getTooltip
in classColumnOptions
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 classColumnOptions
-
getUpColor
See Also:
-
setUpColor
The color used specifically for positive point columns. When not specified, the general series color is used.
In styled mode, the waterfall colors can be set with the
.highcharts-point-negative
,.highcharts-sum
and.highcharts-intermediate-sum
classes. -
getVisible
Specified by:
getVisible
in classColumnOptions
See Also:
-
setVisible
Set the initial visibility of the series.
Defaults to: true
Specified by:
setVisible
in classColumnOptions
-
getZoneAxis
Specified by:
getZoneAxis
in classColumnOptions
See Also:
-
setZoneAxis
Defines the Axis on which the zones are applied.
Defaults to: y
Specified by:
setZoneAxis
in classColumnOptions
-
getZones
Specified by:
getZones
in classColumnOptions
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 classColumnOptions
-
addZone
Adds zone to the zones array
Specified by:
addZone
in classColumnOptions
Parameters:
zone
- to addSee Also:
-
removeZone
Removes first occurrence of zone in zones array
Specified by:
removeZone
in classColumnOptions
Parameters:
zone
- to removeSee Also:
-
setPointStart
Deprecated.as of 4.0. UsesetPointStart(Instant)
Specified by:
setPointStart
in classColumnOptions
See Also:
-
setPointStart
See Also:
-