com.vaadin.flow.component.charts.model.Crosshair Maven / Gradle / Ivy
/**
* Copyright 2000-2024 Vaadin Ltd.
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See {@literal } for the full
* license.
*/
package com.vaadin.flow.component.charts.model;
import com.vaadin.flow.component.charts.model.style.Color;
/**
*
* 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.
*
*/
public class Crosshair extends AbstractConfigurationObject {
private String className;
private Color color;
private DashStyle dashStyle;
private Boolean snap;
private Number width;
private Number zIndex;
private CrosshairLabel label;
public Crosshair() {
}
/**
* @see #setClassName(String)
*/
public String getClassName() {
return className;
}
/**
* A class name for the crosshair, especially as a hook for styling.
*/
public void setClassName(String className) {
this.className = className;
}
/**
* @see #setColor(Color)
*/
public Color getColor() {
return 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.
*/
public void setColor(Color color) {
this.color = color;
}
/**
* @see #setDashStyle(DashStyle)
*/
public DashStyle getDashStyle() {
return dashStyle;
}
/**
* The dash style for the crosshair. See
* series.dashStyle for possible
* values.
*
* Defaults to: Solid
*/
public void setDashStyle(DashStyle dashStyle) {
this.dashStyle = dashStyle;
}
/**
* @see #setSnap(Boolean)
*/
public Boolean getSnap() {
return snap;
}
/**
* Whether the crosshair should snap to the point or follow the pointer
* independent of points.
*
* Defaults to: true
*/
public void setSnap(Boolean snap) {
this.snap = snap;
}
/**
* @see #setWidth(Number)
*/
public Number getWidth() {
return width;
}
/**
* The pixel width of the crosshair. Defaults to 1 for numeric or datetime
* axes, and for one category width for category axes.
*/
public void setWidth(Number width) {
this.width = width;
}
/**
* @see #setZIndex(Number)
*/
public Number getZIndex() {
return 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
*/
public void setZIndex(Number zIndex) {
this.zIndex = zIndex;
}
/**
* @see #setLabel(CrosshairLabel)
*/
public CrosshairLabel getLabel() {
if (label == null) {
label = new CrosshairLabel();
}
return label;
}
/**
*
* A label on the axis next to the crosshair.
*
*
*
* In styled mode, the label is styled with the
* .highcharts-crosshair-label class.
*
*/
public void setLabel(CrosshairLabel label) {
this.label = label;
}
}