CrosshairSettingsModel

16 Mar 20261 minute to read

Interface for a class CrosshairSettings

Properties

dashArray string

Specifies the pattern of dashes and gaps used to stroke the crosshair line.

enable boolean

If set to true, the crosshair line becomes visible.

highlightCategory boolean

If set to true, highlights the entire category range when hovered over.
This property applies only to category axes.

horizontalLineColor string

The color of the horizontal crosshair line accepts values in hex and rgba as valid CSS color strings.

line BorderModel

The line property allows defining the appearance of the crosshair line, including its color and width.

lineType LineType

Specifies the line type for the crosshair.
The available modes are:

• None: Both vertical and horizontal crosshair lines are hidden.
• Both: Displays both the vertical and horizontal crosshair lines.
• Vertical: Shows only the vertical crosshair line.
• Horizontal: Shows only the horizontal crosshair line.

opacity number

Specifies the opacity level for the crosshair, which controls its transparency.

snapToData boolean

Enables or disables the crosshair snap behavior.
When set to true, the crosshair line and its labels snap
to the nearest visible data point, ensuring precise
alignment and accurate value reading.

When set to false, the crosshair moves freely along
the axis without snapping, showing interpolated values
based on the pointer position.

verticalLineColor string

The color of the vertical crosshair line accepts values in hex and rgba as valid CSS color strings.