Class Crosshair

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.