com.vaadin.flow.component.charts.model.Crosshair API 14.12.5 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.6.4 for the latest.

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

java.lang.Object
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
- - com.vaadin.flow.component.charts.model.Crosshair

All Implemented Interfaces:

Serializable
```
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

All Methods
Modifier and Type	Method and Description
`String`	`getClassName()`
`CrosshairLabel`	`getLabel()`
`Boolean`	`getSnap()`
`Number`	`getZIndex()`
`void`	`setClassName(String className)` A class name for the crosshair, especially as a hook for styling.
`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`	`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.
  - 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
  - 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.