Package com.vaadin.flow.component.charts.model

Class PlotBand

java.lang.Object

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

com.vaadin.flow.component.charts.model.PlotBand

All Implemented Interfaces:

Serializable

public class PlotBand
extends AbstractConfigurationObject

An array of objects defining plot bands on the Y axis.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PlotBand()
PlotBand(Number from, Number to, Color color)

Method Summary

Modifier and Type	Method	Description
Color	getBorderColor()
Number	getBorderWidth()
String	getClassName()
Color	getColor()
Number	getFrom()
String	getId()
String	getInnerRadius()
Label	getLabel()
String	getOuterRadius()
String	getThickness()
Number	getTo()
Number	getZIndex()
void	setBorderColor(Color borderColor)	Border color for the plot band.
void	setBorderWidth(Number borderWidth)	Border width for the plot band.
void	setClassName(String className)	A custom class name, in addition to the default highcharts-plot-band, to apply to each individual band.
void	setColor(Color color)	The color of the plot band.
void	setFrom(Number from)	The start position of the plot band in axis units.
void	setFrom(Instant instant)
void	setFrom(Date date)	Deprecated. as of 4.0.
void	setId(String id)	An id used for identifying the plot band in Axis.removePlotBand.
void	setInnerRadius(String innerRadius)	In a gauge chart, this option determines the inner radius of the plot band that stretches along the perimeter.
void	setLabel(Label label)	Text labels for the plot bands
void	setOuterRadius(String outerRadius)	In a gauge chart, this option determines the outer radius of the plot band that stretches along the perimeter.
void	setThickness(String thickness)	In a gauge chart, this option sets the width of the plot band stretching along the perimeter.
void	setTo(Number to)	The end position of the plot band in axis units.
void	setTo(Instant instant)
void	setTo(Date date)	Deprecated. as of 4.0.
void	setZIndex(Number zIndex)	The z index of the plot band within the chart, relative to other elements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlotBand

public PlotBand()

PlotBand

public PlotBand(Number from,
 Number to,
 Color color)

Method Details

getBorderColor

public Color getBorderColor()

See Also:

• setBorderColor(Color)

setBorderColor

public void setBorderColor(Color borderColor)

Border color for the plot band. Also requires borderWidth to be set.

Defaults to: null

getBorderWidth

public Number getBorderWidth()

See Also:

• setBorderWidth(Number)

setBorderWidth

public void setBorderWidth(Number borderWidth)

Border width for the plot band. Also requires borderColor to be set.

Defaults to: 0

getClassName

public String getClassName()

See Also:

• setClassName(String)

setClassName

public void setClassName(String className)

A custom class name, in addition to the default highcharts-plot-band, to apply to each individual band.

getColor

public Color getColor()

See Also:

• setColor(Color)

setColor

public void setColor(Color color)

The color of the plot band.

getFrom

public Number getFrom()

See Also:

• setFrom(Number)

setFrom

public void setFrom(Number from)

The start position of the plot band in axis units.

getId

public String getId()

See Also:

• setId(String)

setId

public void setId(String id)

An id used for identifying the plot band in Axis.removePlotBand.

getInnerRadius

public String getInnerRadius()

See Also:

• setInnerRadius(String)

setInnerRadius

public void setInnerRadius(String innerRadius)

In a gauge chart, this option determines the inner radius of the plot band that stretches along the perimeter. It can be given as a percentage string, like "100%", or as a pixel number, like 100. By default, the inner radius is controlled by the thickness option.

Defaults to: null

getLabel

public Label getLabel()

See Also:

• setLabel(Label)

setLabel

public void setLabel(Label label)

Text labels for the plot bands

getOuterRadius

public String getOuterRadius()

See Also:

• setOuterRadius(String)

setOuterRadius

public void setOuterRadius(String outerRadius)

In a gauge chart, this option determines the outer radius of the plot band that stretches along the perimeter. It can be given as a percentage string, like "100%", or as a pixel number, like 100.

Defaults to: 100%

getThickness

public String getThickness()

See Also:

• setThickness(String)

setThickness

public void setThickness(String thickness)

In a gauge chart, this option sets the width of the plot band stretching along the perimeter. It can be given as a percentage string, like "10%", or as a pixel number, like 10. The default value 10 is the same as the default tickLength, thus making the plot band act as a background for the tick markers.

Defaults to: 10

getTo

public Number getTo()

See Also:

• setTo(Number)

setTo

public void setTo(Number to)

The end position of the plot band in axis units.

getZIndex

public Number getZIndex()

See Also:

• setZIndex(Number)

setZIndex

public void setZIndex(Number zIndex)

The z index of the plot band within the chart, relative to other elements. Using the same z index as another element may give unpredictable results, as the last rendered element will be on top. Values from 0 to 20 make sense.

setFrom

@Deprecated
public void setFrom(Date date)

Deprecated.

as of 4.0. Use #setPointStart(Instant)

setFrom

public void setFrom(Instant instant)

See Also:

• setFrom(Number)

setTo

@Deprecated
public void setTo(Date date)

Deprecated.

as of 4.0. Use #setPointStart(Instant)

setTo

public void setTo(Instant instant)

See Also:

• setTo(Number)