ColumnOptions (Vaadin Platform (vaadin-platform-javadoc) 22.0.26 API)

java.lang.Object
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
- - com.vaadin.flow.component.charts.model.AbstractPlotOptions
  - - com.vaadin.flow.component.charts.model.ColumnOptions

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PlotOptionsBar, PlotOptionsColumn, PlotOptionsColumnrange, PlotOptionsWaterfall
```
public abstract class ColumnOptions
extends AbstractPlotOptions
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ColumnOptions()

Constructors
Constructor and Description
`ColumnOptions()`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract void`	`addColor(Color color)` Adds color to the colors array
`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 Color`	`getBorderColor()`
`abstract Number`	`getBorderRadius()`
`abstract Number`	`getBorderWidth()`
`abstract Boolean`	`getClip()`
`abstract Boolean`	`getColorByPoint()`
`abstract String`	`getColorKey()`
`abstract Color[]`	`getColors()`
`abstract Boolean`	`getCrisp()`
`abstract Cursor`	`getCursor()`
`abstract Number`	`getDepth()`
`abstract Color`	`getEdgeColor()`
`abstract Number`	`getEdgeWidth()`
`abstract Boolean`	`getEnableMouseTracking()`
`abstract Boolean`	`getGetExtremesFromAll()`
`abstract Boolean`	`getGrouping()`
`abstract Number`	`getGroupPadding()`
`abstract Number`	`getGroupZPadding()`
`abstract String[]`	`getKeys()`
`abstract String`	`getLinkedTo()`
`abstract Number`	`getMaxPointWidth()`
`abstract Number`	`getMinPointLength()`
`abstract Number`	`getOpacity()`
`abstract Number`	`getPointInterval()`
`abstract IntervalUnit`	`getPointIntervalUnit()`
`abstract Number`	`getPointPadding()`
`abstract PointPlacement`	`getPointPlacement()`
`abstract Number`	`getPointRange()`
`abstract Number`	`getPointStart()`
`abstract Number`	`getPointWidth()`
`abstract Boolean`	`getSelected()`
`abstract Boolean`	`getShadow()`
`abstract Boolean`	`getShowCheckbox()`
`abstract Boolean`	`getShowInLegend()`
`abstract States`	`getStates()`
`abstract Boolean`	`getStickyTracking()`
`abstract SeriesTooltip`	`getTooltip()`
`abstract Boolean`	`getVisible()`
`abstract ZoneAxis`	`getZoneAxis()`
`abstract Zones[]`	`getZones()`
`abstract void`	`removeColor(Color color)` Removes first occurrence of color in colors array
`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`	`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`	`setClip(Boolean clip)` 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`	`setColors(Color... colors)` A series specific or series type specific color set to apply instead of the theme colors when `setColorByPoint(Boolean)` is true.
`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`	`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`	`setDepth(Number depth)` 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`	`setKeys(String... keys)` 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` and `year`.
`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(Date date)`
`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`	`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`	`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`	`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`	`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`	`setZones(Zones... zones)` An array defining zones within a series.

Methods inherited from class com.vaadin.flow.component.charts.model.AbstractPlotOptions
getChartType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ColumnOptions
```
public ColumnOptions()
```
- Method Detail
  - getAllowPointSelect
```
public abstract Boolean getAllowPointSelect()
```
    See Also:
    
    setAllowPointSelect(Boolean)
  - 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(Boolean)
  - 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.
  - getBorderColor
```
public abstract Color getBorderColor()
```
    See Also:
    
    setBorderColor(Color)
  - setBorderColor
```
public abstract void setBorderColor(Color borderColor)
```
    The color of the border of each waterfall column.
  - getBorderRadius
```
public abstract Number getBorderRadius()
```
    See Also:
    
    setBorderRadius(Number)
  - setBorderRadius
```
public abstract void setBorderRadius(Number borderRadius)
```
    The corner radius of the border surrounding each column or bar.
  - getBorderWidth
```
public abstract Number getBorderWidth()
```
    See Also:
    
    setBorderWidth(Number)
  - setBorderWidth
```
public abstract void setBorderWidth(Number borderWidth)
```
    The width of the border surrounding each column or bar.
  - getClip
```
public abstract Boolean getClip()
```
    See Also:
    
    setClip(Boolean)
  - setClip
```
public abstract void setClip(Boolean clip)
```
    Disable this option to allow series rendering in the whole plotting area.
  - getColorByPoint
```
public abstract Boolean getColorByPoint()
```
    See Also:
    
    setColorByPoint(Boolean)
  - setColorByPoint
```
public 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.
  - getColorKey
```
public abstract String getColorKey()
```
    See Also:
    
    setColorKey(String)
  - setColorKey
```
public abstract void setColorKey(String colorKey)
```
    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''.
  - getColors
```
public abstract Color[] getColors()
```
    See Also:
    
    setColors(Color...)
  - setColors
```
public abstract void setColors(Color... colors)
```
    A series specific or series type specific color set to apply instead of the theme colors when setColorByPoint(Boolean) is true.
  - addColor
```
public abstract void addColor(Color color)
```
    Adds color to the colors array
    
    Parameters:
    
    color - to add
    
    See Also:
    
    setColors(Color...)
  - removeColor
```
public abstract void removeColor(Color color)
```
    Removes first occurrence of color in colors array
    
    Parameters:
    
    color - to remove
    
    See Also:
    
    setColors(Color...)
  - getCrisp
```
public abstract Boolean getCrisp()
```
    See Also:
    
    setCrisp(Boolean)
  - 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 to false may look better, even though each column is rendered blurry.
  - getCursor
```
public abstract Cursor getCursor()
```
    See Also:
    
    setCursor(Cursor)
  - 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.
  - getDepth
```
public abstract Number getDepth()
```
    See Also:
    
    setDepth(Number)
  - setDepth
```
public abstract void setDepth(Number depth)
```
    Depth of the columns in a 3D column chart.
  - getEdgeColor
```
public abstract Color getEdgeColor()
```
    See Also:
    
    setEdgeColor(Color)
  - setEdgeColor
```
public abstract void setEdgeColor(Color edgeColor)
```
    3D columns only. The color of the edges.
  - getEdgeWidth
```
public abstract Number getEdgeWidth()
```
    See Also:
    
    setEdgeWidth(Number)
  - setEdgeWidth
```
public abstract void setEdgeWidth(Number edgeWidth)
```
    3D columns only. The width of the colored edges.
  - getEnableMouseTracking
```
public abstract Boolean getEnableMouseTracking()
```
    See Also:
    
    setEnableMouseTracking(Boolean)
  - 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.
  - getGetExtremesFromAll
```
public abstract Boolean getGetExtremesFromAll()
```
    See Also:
    
    setGetExtremesFromAll(Boolean)
  - 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.
  - getGroupPadding
```
public abstract Number getGroupPadding()
```
    See Also:
    
    setGroupPadding(Number)
  - setGroupPadding
```
public abstract void setGroupPadding(Number groupPadding)
```
    Padding between each value groups, in x axis units.
  - getGroupZPadding
```
public abstract Number getGroupZPadding()
```
    See Also:
    
    setGroupZPadding(Number)
  - setGroupZPadding
```
public abstract void setGroupZPadding(Number groupZPadding)
```
    The spacing between columns on the Z Axis in a 3D chart.
  - getGrouping
```
public abstract Boolean getGrouping()
```
    See Also:
    
    setGrouping(Boolean)
  - setGrouping
```
public abstract void setGrouping(Boolean grouping)
```
    Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.
  - getKeys
```
public abstract String[] getKeys()
```
    See Also:
    
    setKeys(String...)
  - 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 add
    
    See Also:
    
    setKeys(String...)
  - removeKey
```
public abstract void removeKey(String key)
```
    Removes first occurrence of key in keys array
    
    Parameters:
    
    key - to remove
    
    See Also:
    
    setKeys(String...)
  - getLinkedTo
```
public abstract String getLinkedTo()
```
    See Also:
    
    setLinkedTo(String)
  - 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.
  - getOpacity
```
public abstract Number getOpacity()
```
    See Also:
    
    setOpacity(Number)
  - setOpacity
```
public abstract void setOpacity(Number opacity)
```
    Opacity of a series parts: line, fill (e.g. area) and dataLabels.
  - getMaxPointWidth
```
public abstract Number getMaxPointWidth()
```
    See Also:
    
    setMaxPointWidth(Number)
  - setMaxPointWidth
```
public abstract void setMaxPointWidth(Number maxPointWidth)
```
    The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.
  - getMinPointLength
```
public abstract Number getMinPointLength()
```
    See Also:
    
    setMinPointLength(Number)
  - setMinPointLength
```
public abstract void setMinPointLength(Number minPointLength)
```
    The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.
  - getPointInterval
```
public abstract Number getPointInterval()
```
    See Also:
    
    setPointInterval(Number)
  - 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(IntervalUnit)
  - setPointIntervalUnit
```
public abstract void setPointIntervalUnit(IntervalUnit pointIntervalUnit)
```
    On datetime series, this allows for setting the pointInterval to irregular time units, day, month and year. 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 with pointInterval to draw weeks, quarters, 6 months, 10 years etc.
  - getPointPadding
```
public abstract Number getPointPadding()
```
    See Also:
    
    setPointPadding(Number)
  - setPointPadding
```
public abstract void setPointPadding(Number pointPadding)
```
    Padding between each column or bar, in x axis units.
  - getPointPlacement
```
public abstract PointPlacement getPointPlacement()
```
    See Also:
    
    setPointPlacement(PointPlacement)
  - 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(Number)
  - setPointRange
```
public abstract void setPointRange(Number pointRange)
```
    The X axis range that each point is valid for. This determines the width of the column. On a categorized axis, the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as the distance between the two closest data points.
  - getPointStart
```
public abstract Number getPointStart()
```
    See Also:
    
    setPointStart(Number)
  - 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.
  - getPointWidth
```
public abstract Number getPointWidth()
```
    See Also:
    
    setPointWidth(Number)
  - setPointWidth
```
public abstract void setPointWidth(Number pointWidth)
```
    A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.
  - getSelected
```
public abstract Boolean getSelected()
```
    See Also:
    
    setSelected(Boolean)
  - 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(Boolean)
  - 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(Boolean)
  - 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(Boolean)
  - 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.
  - getStates
```
public abstract States getStates()
```
    See Also:
    
    setStates(States)
  - 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(Boolean)
  - 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, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series.
  - getTooltip
```
public abstract SeriesTooltip getTooltip()
```
    See Also:
    
    setTooltip(SeriesTooltip)
  - setTooltip
```
public abstract void setTooltip(SeriesTooltip tooltip)
```
    A configuration object for the tooltip rendering of each single series.
  - getVisible
```
public abstract Boolean getVisible()
```
    See Also:
    
    setVisible(Boolean)
  - setVisible
```
public abstract void setVisible(Boolean visible)
```
    Set the initial visibility of the series.
  - getZoneAxis
```
public abstract ZoneAxis getZoneAxis()
```
    See Also:
    
    setZoneAxis(ZoneAxis)
  - setZoneAxis
```
public abstract void setZoneAxis(ZoneAxis zoneAxis)
```
    Defines the Axis on which the zones are applied.
  - getZones
```
public abstract Zones[] getZones()
```
    See Also:
    
    setZones(Zones...)
  - 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 add
    
    See Also:
    
    setZones(Zones...)
  - removeZone
```
public abstract void removeZone(Zones zone)
```
    Removes first occurrence of zone in zones array
    
    Parameters:
    
    zone - to remove
    
    See Also:
    
    setZones(Zones...)
  - setPointStart
```
public abstract void setPointStart(Date date)
```
    See Also:
    
    setPointStart(Number)

Class ColumnOptions

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.flow.component.charts.model.AbstractPlotOptions

Methods inherited from class java.lang.Object

Constructor Detail

ColumnOptions

Method Detail

getAllowPointSelect

setAllowPointSelect

getAnimation

setAnimation

getBorderColor

setBorderColor

getBorderRadius

setBorderRadius

getBorderWidth

setBorderWidth

getClip

setClip

getColorByPoint

setColorByPoint

getColorKey

setColorKey

getColors

setColors

addColor

removeColor

getCrisp

setCrisp

getCursor

setCursor

getDepth

setDepth

getEdgeColor

setEdgeColor

getEdgeWidth

setEdgeWidth

getEnableMouseTracking

setEnableMouseTracking

getGetExtremesFromAll

setGetExtremesFromAll

getGroupPadding

setGroupPadding

getGroupZPadding

setGroupZPadding

getGrouping

setGrouping

getKeys

setKeys

addKey

removeKey

getLinkedTo

setLinkedTo

getOpacity

setOpacity

getMaxPointWidth

setMaxPointWidth

getMinPointLength

setMinPointLength

getPointInterval

setPointInterval

getPointIntervalUnit

setPointIntervalUnit

getPointPadding

setPointPadding

getPointPlacement

setPointPlacement

getPointRange

setPointRange

getPointStart

setPointStart

getPointWidth

setPointWidth

getSelected

setSelected

getShadow

setShadow

getShowCheckbox

setShowCheckbox