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

Class CrosshairLabel

java.lang.Object

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

com.vaadin.flow.component.charts.model.CrosshairLabel

All Implemented Interfaces:

Serializable

public class CrosshairLabel
extends AbstractConfigurationObject

A label on the axis next to the crosshair.

In styled mode, the label is styled with the .highcharts-crosshair-label class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CrosshairLabel()
CrosshairLabel(Boolean enabled)

Method Summary

Modifier and Type	Method	Description
HorizontalAlign	getAlign()
Color	getBackgroundColor()
Color	getBorderColor()
Number	getBorderRadius()
Number	getBorderWidth()
Boolean	getEnabled()
String	getFormat()
String	getFormatter()
Number	getPadding()
Shape	getShape()
void	setAlign(HorizontalAlign align)	Alignment of the label compared to the axis.
void	setBackgroundColor(Color backgroundColor)	The background color for the label.
void	setBorderColor(Color borderColor)	The border color for the crosshair label
void	setBorderRadius(Number borderRadius)	The border corner radius of the crosshair label.
void	setBorderWidth(Number borderWidth)	The border width for the crosshair label.
void	setEnabled(Boolean enabled)
void	setFormat(String format)	A format string for the crosshair label.
void	setFormatter(String _fn_formatter)
void	setPadding(Number padding)	Padding inside the crosshair label.
void	setShape(Shape shape)	The shape to use for the label box.

Methods inherited from class java.lang.Object

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

Constructor Detail

CrosshairLabel

public CrosshairLabel()

CrosshairLabel

public CrosshairLabel(Boolean enabled)

Method Detail

getAlign

public HorizontalAlign getAlign()

See Also:

setAlign(HorizontalAlign)

setAlign

public void setAlign(HorizontalAlign align)

Alignment of the label compared to the axis. Defaults to left for right-side axes, right for left-side axes and center for horizontal axes.

getBackgroundColor

public Color getBackgroundColor()

See Also:

setBackgroundColor(Color)

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

The background color for the label. Defaults to the related series color, or #666666 if that is not available.

getBorderColor

public Color getBorderColor()

See Also:

setBorderColor(Color)

setBorderColor

public void setBorderColor(Color borderColor)

The border color for the crosshair label

getBorderRadius

public Number getBorderRadius()

See Also:

setBorderRadius(Number)

setBorderRadius

public void setBorderRadius(Number borderRadius)

The border corner radius of the crosshair label.

Defaults to: 3

getBorderWidth

public Number getBorderWidth()

See Also:

setBorderWidth(Number)

setBorderWidth

public void setBorderWidth(Number borderWidth)

The border width for the crosshair label.

Defaults to: 0

getFormat

public String getFormat()

See Also:

setFormat(String)

setFormat

public void setFormat(String format)

A format string for the crosshair label. Defaults to {value} for numeric axes and {value:%b %d, %Y} for datetime axes.

getFormatter

public String getFormatter()

setFormatter

public void setFormatter(String _fn_formatter)

getPadding

public Number getPadding()

See Also:

setPadding(Number)

setPadding

public void setPadding(Number padding)

Padding inside the crosshair label.

Defaults to: 8

getShape

public Shape getShape()

See Also:

setShape(Shape)

setShape

public void setShape(Shape shape)

The shape to use for the label box.

Defaults to: callout

getEnabled

public Boolean getEnabled()

See Also:

setEnabled(Boolean)

setEnabled

public void setEnabled(Boolean enabled)