Package com.vaadin.componentfactory.maps.model

Class Crosshair

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.Crosshair
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class Crosshair extends AbstractConfigurationObject
Configure a crosshair that follows either the mouse pointer or the hovered point.
Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • Crosshair

      public Crosshair()

      Constructor for Crosshair.

  • Method Details

    • getColor

      public Color getColor()

      Getter for the field color.

      Returns:
      a Color object.
      See Also:

    • setColor

      public void setColor(Color color)
      The color of the crosshair.

      Defaults to: #C0C0C0

      Parameters:
      color - a Color object.

    • getDashStyle

      public DashStyle getDashStyle()

      Getter for the field dashStyle.

      Returns:
      a DashStyle object.
      See Also:

    • setDashStyle

      public void setDashStyle(DashStyle dashStyle)
      The dash style for the crosshair. See series.dashStyle for possible values.

      Defaults to: Solid

      Parameters:
      dashStyle - a DashStyle object.

    • getSnap

      public Boolean getSnap()

      Getter for the field snap.

      Returns:
      a Boolean object.
      See Also:

    • setSnap

      public void setSnap(Boolean snap)
      Whether the crosshair should snap to the point or follow the pointer independent of points.

      Defaults to: true

      Parameters:
      snap - a Boolean object.

    • getWidth

      public Number getWidth()

      Getter for the field width.

      Returns:
      a Number object.
      See Also:

    • 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.
      Parameters:
      width - a Number object.

    • getZIndex

      public Number getZIndex()

      Getter for the field zIndex.

      Returns:
      a Number object.
      See Also:

    • 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

      Parameters:
      zIndex - a Number object.