Components / Charts / API

AxisDefaultsCrosshair

The configuration options of the axis crosshair
(see example).

color? string

The color of the crosshair. Accepts a valid CSS color string, including hex and rgb.

dashType? DashType

The dash type of the crosshair.

The following dash types are supported:

  • "dash"—A line which consists of dashes.
  • "dashDot"—A line which consists of a repeating pattern of dash-dot.
  • "dot"—A line which consists of dots.
  • "longDash"—A line which consists of a repeating pattern of long-dash.
  • "longDashDot"—A line which consists of a repeating pattern of long-dash-dot.
  • "longDashDotDot"—A line which consists of a repeating pattern of long-dash-dot-dot.
  • "solid"—A solid line.

opacity? number

The opacity of the crosshair. By default, the crosshair is opaque.

tooltip? AxisDefaultsCrosshairTooltip

The options of the crosshair tooltip.
The crosshair tooltip is displayed when the axisDefaults.crosshair.tooltip.visible
option is set to true.

visible? boolean

If set to true, the Chart displays the axis crosshair.
By default, the axis crosshair is not visible.

width? number

The width of the crosshair in pixels.