com.vaadin.flow.component.charts.model.
Class ColumnOptions
All Implemented Interfaces:
Direct Known Subclasses:
PlotOptionsBar
, PlotOptionsColumn
, PlotOptionsColumnrange
, PlotOptionsWaterfall
See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract void
Adds color to the colors array
abstract void
Adds key to the keys array
abstract void
Adds zone to the zones array
abstract Boolean
abstract Boolean
abstract Color
abstract Number
abstract Number
abstract Boolean
getClip()
abstract Boolean
abstract String
abstract Color[]
abstract Boolean
getCrisp()
abstract Cursor
abstract Number
getDepth()
abstract Color
abstract Number
abstract Boolean
abstract Boolean
abstract Boolean
abstract Number
abstract Number
abstract String[]
getKeys()
abstract String
abstract Number
abstract Number
abstract Number
abstract Number
abstract IntervalUnit
abstract Number
abstract PointPlacement
abstract Number
abstract Number
abstract Number
abstract Boolean
abstract Boolean
abstract Boolean
abstract Boolean
abstract States
abstract Boolean
abstract SeriesTooltip
abstract Boolean
abstract ZoneAxis
abstract Zones[]
getZones()
abstract void
removeColor
(Color color) Removes first occurrence of color in colors array
abstract void
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
setBorderColor
(Color borderColor) The color of the border of each waterfall column.
abstract void
setBorderRadius
(Number borderRadius) The corner radius of the border surrounding each column or bar.
abstract void
setBorderWidth
(Number borderWidth) The width of the border surrounding each column or bar.
abstract void
Disable this option to allow series rendering in the whole plotting area.
abstract 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.abstract void
setColorKey
(String colorKey) Determines what data value should be used to calculate point color if colorAxis is used.
abstract void
A series specific or series type specific color set to apply instead of the theme colors when
setColorByPoint(Boolean)
is true.abstract void
When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen.
abstract 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.
abstract void
Depth of the columns in a 3D column chart.
abstract void
setEdgeColor
(Color edgeColor) 3D columns only.
abstract void
setEdgeWidth
(Number edgeWidth) 3D columns only.
abstract void
setEnableMouseTracking
(Boolean enableMouseTracking) Enable or disable the mouse tracking for a specific series.
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
setGrouping
(Boolean grouping) Whether to group non-stacked columns or to let them render independent of each other.
abstract void
setGroupPadding
(Number groupPadding) Padding between each value groups, in x axis units.
abstract void
setGroupZPadding
(Number groupZPadding) The spacing between columns on the Z Axis in a 3D chart.
abstract void
An array specifying which option maps to which key in the data point array.
abstract void
setLinkedTo
(String linkedTo) The ID of another series to link to.
abstract void
setMaxPointWidth
(Number maxPointWidth) The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.
abstract void
setMinPointLength
(Number minPointLength) The minimal height for a column or width for a bar.
abstract void
setOpacity
(Number opacity) Opacity of a series parts: line, fill (e.g.
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
setPointPadding
(Number pointPadding) Padding between each column or bar, in x axis units.
abstract void
setPointPlacement
(PointPlacement pointPlacement) Possible values:
null
,"on"
,"between"
.abstract void
setPointRange
(Number pointRange) The X axis range that each point is valid for.
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
(Date date) abstract void
setPointWidth
(Number pointWidth) A pixel value specifying a fixed width for each column or bar.
abstract void
setSelected
(Boolean selected) Whether to select the series initially.
abstract void
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
A wrapper object for all the series options in specific states.
abstract void
setStickyTracking
(Boolean stickyTracking) Sticky tracking of mouse events.
abstract void
setTooltip
(SeriesTooltip tooltip) A configuration object for the tooltip rendering of each single series.
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
An array defining zones within a series.
Methods inherited from class com.vaadin.flow.component.charts.model.AbstractPlotOptions
getChartType
-
Constructor Details
-
ColumnOptions
public ColumnOptions()
-
-
Method Details
-
getAllowPointSelect
See Also:
-
setAllowPointSelect
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
-
getAnimation
See Also:
-
setAnimation
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.
-
getBorderColor
See Also:
-
setBorderColor
The color of the border of each waterfall column.
-
getBorderRadius
See Also:
-
setBorderRadius
The corner radius of the border surrounding each column or bar.
-
getBorderWidth
See Also:
-
setBorderWidth
The width of the border surrounding each column or bar.
-
getClip
See Also:
-
setClip
Disable this option to allow series rendering in the whole plotting area.
-
getColorByPoint
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. -
getColorKey
See Also:
-
setColorKey
Determines what data value should be used to calculate point color if colorAxis is used. Requires to set
min
andmax
if some custom point property is used or if approximation for data grouping is set to'sum'
'. -
getColors
See Also:
-
setColors
A series specific or series type specific color set to apply instead of the theme colors when
setColorByPoint(Boolean)
is true. -
addColor
Adds color to the colors array
Parameters:
color
- to addSee Also:
-
removeColor
Removes first occurrence of color in colors array
Parameters:
color
- to removeSee Also:
-
getCrisp
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 to false may look better, even though each column is rendered blurry.
-
getCursor
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.
-
getDepth
See Also:
-
setDepth
Depth of the columns in a 3D column chart.
-
getEdgeColor
See Also:
-
setEdgeColor
3D columns only. The color of the edges.
-
getEdgeWidth
See Also:
-
setEdgeWidth
3D columns only. The width of the colored edges.
-
getEnableMouseTracking
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.
-
getGetExtremesFromAll
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.
-
getGroupPadding
See Also:
-
setGroupPadding
Padding between each value groups, in x axis units.
-
getGroupZPadding
See Also:
-
setGroupZPadding
The spacing between columns on the Z Axis in a 3D chart.
-
getGrouping
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.
-
getKeys
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.
-
addKey
Adds key to the keys array
Parameters:
key
- to addSee Also:
-
removeKey
Removes first occurrence of key in keys array
Parameters:
key
- to removeSee Also:
-
getLinkedTo
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.
-
getOpacity
See Also:
-
setOpacity
Opacity of a series parts: line, fill (e.g. area) and dataLabels.
-
getMaxPointWidth
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.
-
getMinPointLength
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.
-
getPointInterval
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.
It can be combined with
pointIntervalUnit
to draw irregular intervals. -
getPointIntervalUnit
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. -
getPointPadding
See Also:
-
setPointPadding
Padding between each column or bar, in x axis units.
-
getPointPlacement
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.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
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.
-
getPointStart
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.
-
getPointWidth
See Also:
-
setPointWidth
A pixel value specifying a fixed width for each column or bar. When
null
, the width is calculated from thepointPadding
andgroupPadding
. -
getSelected
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. -
getShadow
See Also:
-
setShadow
Whether to apply a drop shadow to the graph line.
-
getShowCheckbox
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. -
getShowInLegend
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. -
getStates
See Also:
-
setStates
A wrapper object for all the series options in specific states.
-
getStickyTracking
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. -
getTooltip
See Also:
-
setTooltip
A configuration object for the tooltip rendering of each single series.
-
getVisible
See Also:
-
setVisible
Set the initial visibility of the series.
-
getZoneAxis
See Also:
-
setZoneAxis
Defines the Axis on which the zones are applied.
-
getZones
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. -
addZone
Adds zone to the zones array
Parameters:
zone
- to addSee Also:
-
removeZone
Removes first occurrence of zone in zones array
Parameters:
zone
- to removeSee Also:
-
setPointStart
See Also:
-