com.vaadin.flow.component.charts.model

Class GaugeOptions

java.lang.Object

com.vaadin.flow.component.charts.model.AbstractConfigurationObject

com.vaadin.flow.component.charts.model.AbstractPlotOptions

com.vaadin.flow.component.charts.model.GaugeOptions

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PlotOptionsGauge, PlotOptionsSolidgauge

public abstract class GaugeOptions
extends AbstractPlotOptions

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GaugeOptions()

Method Summary

Modifier and Type	Method and Description
abstract void	addKey(String key) Adds key to the keys array
abstract Boolean	getAnimation()
abstract Boolean	getClip()
abstract Boolean	getCrisp()
abstract Cursor	getCursor()
abstract DataLabels	getDataLabels()
abstract Boolean	getEnableMouseTracking()
abstract Boolean	getGetExtremesFromAll()
abstract String[]	getKeys()
abstract Number	getOpacity()
abstract Number	getOvershoot()
abstract Boolean	getSelected()
abstract Boolean	getShowCheckbox()
abstract Boolean	getShowInLegend()
abstract Boolean	getStickyTracking()
abstract SeriesTooltip	getTooltip()
abstract Boolean	getVisible()
abstract Boolean	getWrap()
abstract void	removeKey(String key) Removes first occurrence of key in keys array
abstract void	setAnimation(Boolean animation) Enable or disable the initial animation when a series is displayed.
abstract void	setClip(Boolean clip) Disable this option to allow series rendering in the whole plotting area.
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	setDataLabels(DataLabels dataLabels) Data labels for the gauge.
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	setKeys(String... keys) An array specifying which option maps to which key in the data point array.
abstract void	setOpacity(Number opacity) Opacity of a series parts: line, fill (e.g.
abstract void	setOvershoot(Number overshoot) Allow the dial to overshoot the end of the perimeter axis by this many degrees.
abstract void	setSelected(Boolean selected) Whether to select the series initially.
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	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	setWrap(Boolean wrap) When this option is true, the dial will wrap around the axes.

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

GaugeOptions

public GaugeOptions()

Method Detail

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.

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. Note that clipping should be always enabled when chart.zoomType is set

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.

getDataLabels

public abstract DataLabels getDataLabels()

See Also:

setDataLabels(DataLabels)

setDataLabels

public abstract void setDataLabels(DataLabels dataLabels)

Data labels for the gauge. For gauges, the data labels are enabled by default and shown in a bordered box below the point.

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.

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...)

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.

getOvershoot

public abstract Number getOvershoot()

See Also:

setOvershoot(Number)

setOvershoot

public abstract void setOvershoot(Number overshoot)

Allow the dial to overshoot the end of the perimeter axis by this many degrees. Say if the gauge axis goes from 0 to 60, a value of 100, or 1000, will show 5 degrees beyond the end of the axis.

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.

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.

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.

getWrap

public abstract Boolean getWrap()

See Also:

setWrap(Boolean)

setWrap

public abstract void setWrap(Boolean wrap)

When this option is true, the dial will wrap around the axes. For instance, in a full-range gauge going from 0 to 360, a value of 400 will point to 40. When wrap is false, the dial stops at 360.