com.vaadin.flow.component.charts.model

Class Crosshair

java.lang.Object

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

com.vaadin.flow.component.charts.model.Crosshair

All Implemented Interfaces:

Serializable

@Generated(value="This class is generated and shouldn\'t be modified",
           comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new")
public class Crosshair
extends AbstractConfigurationObject

Configure a crosshair that follows either the mouse pointer or the hovered point. By default, the crosshair is enabled on the X axis and disabled on Y axis.

In styled mode, the crosshairs are styled in the .highcharts-crosshair, .highcharts-crosshair-thin or .highcharts-xaxis-category classes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Crosshair()

Method Summary

Modifier and Type	Method and Description
String	getClassName()
Color	getColor()
DashStyle	getDashStyle()
CrosshairLabel	getLabel()
Boolean	getSnap()
Number	getWidth()
Number	getZIndex()
void	setClassName(String className) A class name for the crosshair, especially as a hook for styling.
void	setColor(Color color) The color of the crosshair.
void	setDashStyle(DashStyle dashStyle) The dash style for the crosshair.
void	setLabel(CrosshairLabel label) A label on the axis next to the crosshair.
void	setSnap(Boolean snap) Whether the crosshair should snap to the point or follow the pointer independent of points.
void	setWidth(Number width) The pixel width of the crosshair.
void	setZIndex(Number zIndex) The Z index of the crosshair.

Methods inherited from class java.lang.Object

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

Constructor Detail

Crosshair

public Crosshair()

Method Detail

getClassName

public String getClassName()

See Also:

setClassName(String)

setClassName

public void setClassName(String className)

A class name for the crosshair, especially as a hook for styling.

getColor

public Color getColor()

See Also:

setColor(Color)

setColor

public void setColor(Color color)

The color of the crosshair. Defaults to #cccccc for numeric and datetime axes, and rgba(204,214,235,0.25) for category axes, where the crosshair by default highlights the whole category.

getDashStyle

public DashStyle getDashStyle()

See Also:

setDashStyle(DashStyle)

setDashStyle

public void setDashStyle(DashStyle dashStyle)

The dash style for the crosshair. See series.dashStyle for possible values.

Defaults to: Solid

getSnap

public Boolean getSnap()

See Also:

setSnap(Boolean)

setSnap

public void setSnap(Boolean snap)

Whether the crosshair should snap to the point or follow the pointer independent of points.

Defaults to: true

getWidth

public Number getWidth()

See Also:

setWidth(Number)

setWidth

public void setWidth(Number width)

The pixel width of the crosshair. Defaults to 1 for numeric or datetime axes, and for one category width for category axes.

getZIndex

public Number getZIndex()

See Also:

setZIndex(Number)

setZIndex

public void setZIndex(Number zIndex)

The Z index of the crosshair. Higher Z indices allow drawing the crosshair on top of the series or behind the grid lines.

Defaults to: 2

getLabel

public CrosshairLabel getLabel()

See Also:

setLabel(CrosshairLabel)

setLabel

public void setLabel(CrosshairLabel label)

A label on the axis next to the crosshair.

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