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

Class PlotLine

java.lang.Object

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

com.vaadin.flow.component.charts.model.PlotLine

All Implemented Interfaces:

Serializable

public class PlotLine
extends AbstractConfigurationObject

An array of lines stretching across the plot area, marking a specific value on one of the axes.

In styled mode, the plot lines are styled by the .highcharts-plot-line class in addition to the className option.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PlotLine()
PlotLine(Number value, Number width, Color color)

Method Summary

Modifier and Type	Method	Description
String	getClassName()
Color	getColor()
DashStyle	getDashStyle()
String	getId()
Label	getLabel()
Number	getValue()
Number	getWidth()
Number	getZIndex()
void	setClassName(String className)	A custom class name, in addition to the default highcharts-plot-line, to apply to each individual line.
void	setColor(Color color)	The color of the line.
void	setDashStyle(DashStyle dashStyle)	The dashing or dot style for the plot line.
void	setId(String id)	An id used for identifying the plot line in Axis.removePlotLine.
void	setLabel(Label label)	Text labels for the plot bands
void	setValue(Number value)	The position of the line in axis units.
void	setWidth(Number width)	The width or thickness of the plot line.
void	setZIndex(Number zIndex)	The z index of the plot line within the chart.

Methods inherited from class java.lang.Object

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

Constructor Details

PlotLine

public PlotLine()

PlotLine

public PlotLine(Number value,
 Number width,
 Color color)

Method Details

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-line, to apply to each individual line.

getColor

public Color getColor()

See Also:

• setColor(Color)

setColor

public void setColor(Color color)

The color of the line.

getDashStyle

public DashStyle getDashStyle()

See Also:

• setDashStyle(DashStyle)

setDashStyle

public void setDashStyle(DashStyle dashStyle)

The dashing or dot style for the plot line. For possible values see this overview.

Defaults to: Solid

getId

public String getId()

See Also:

• setId(String)

setId

public void setId(String id)

An id used for identifying the plot line in Axis.removePlotLine.

getLabel

public Label getLabel()

See Also:

• setLabel(Label)

setLabel

public void setLabel(Label label)

Text labels for the plot bands

getValue

public Number getValue()

See Also:

• setValue(Number)

setValue

public void setValue(Number value)

The position of the line in axis units.

getWidth

public Number getWidth()

See Also:

• setWidth(Number)

setWidth

public void setWidth(Number width)

The width or thickness of the plot line.

getZIndex

public Number getZIndex()

See Also:

• setZIndex(Number)

setZIndex

public void setZIndex(Number zIndex)

The z index of the plot line within the chart.