com.github.fluorumlabs.disconnect.highcharts.XAxisCrosshairOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of disconnect-highcharts Show documentation
Highcharts API bindings for Disconnect Zero
There is a newer version: 0.1.0-alpha2
Show newest version
package com.github.fluorumlabs.disconnect.highcharts;

import java.lang.String;
import javax.annotation.Nullable;
import js.extras.JsEnum;
import js.lang.Any;
import js.lang.Unknown;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Highmaps) Configure a crosshair that follows either
 * the mouse pointer or the hovered point.
 *
 * In styled mode, the crosshairs are styled in the .highcharts-crosshair,
 * .highcharts-crosshair-thin or .highcharts-xaxis-category classes.
 *
 * @see https://api.highcharts.com/highcharts/xAxis.crosshair
 * @see https://api.highcharts.com/highstock/xAxis.crosshair
 * @see https://api.highcharts.com/highmaps/xAxis.crosshair
 *
 */
public interface XAxisCrosshairOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) A class name for the crosshair,
   * especially as a hook for styling.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.className
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.className
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.className
   *
   * @implspec className?: string;
   *
   */
  @JSProperty("className")
  @Nullable
  String getClassName();

  /**
   * (Highcharts, Highstock, Highmaps) A class name for the crosshair,
   * especially as a hook for styling.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.className
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.className
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.className
   *
   * @implspec className?: string;
   *
   */
  @JSProperty("className")
  void setClassName(String value);

  /**
   * (Highcharts, Highstock, Highmaps) 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.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.color
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.color
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  @Nullable
  Unknown getColor();

  /**
   * (Highcharts, Highstock, Highmaps) 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.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.color
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.color
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(GradientColorObject value);

  /**
   * (Highcharts, Highstock, Highmaps) 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.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.color
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.color
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(String value);

  /**
   * (Highcharts, Highstock, Highmaps) 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.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.color
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.color
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(Any value);

  /**
   * (Highcharts, Highstock, Highmaps) The dash style for the crosshair. See
   * series.dashStyle for possible values.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.dashStyle
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.dashStyle
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.dashStyle
   *
   * @implspec dashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
   *
   */
  @JSProperty("dashStyle")
  @Nullable
  DashStyle getDashStyle();

  /**
   * (Highcharts, Highstock, Highmaps) The dash style for the crosshair. See
   * series.dashStyle for possible values.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.dashStyle
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.dashStyle
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.dashStyle
   *
   * @implspec dashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
   *
   */
  @JSProperty("dashStyle")
  void setDashStyle(DashStyle value);

  /**
   * (Highstock) A label on the axis next to the crosshair.
   *
   * In styled mode, the label is styled with the
   * .highcharts-crosshair-label class.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label
   *
   * @implspec label?: XAxisCrosshairLabelOptions;
   *
   */
  @JSProperty("label")
  @Nullable
  XAxisCrosshairLabelOptions getLabel();

  /**
   * (Highstock) A label on the axis next to the crosshair.
   *
   * In styled mode, the label is styled with the
   * .highcharts-crosshair-label class.
   *
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.label
   *
   * @implspec label?: XAxisCrosshairLabelOptions;
   *
   */
  @JSProperty("label")
  void setLabel(XAxisCrosshairLabelOptions value);

  /**
   * (Highcharts, Highstock, Highmaps) Whether the crosshair should snap to
   * the point or follow the pointer independent of points.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.snap
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.snap
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.snap
   *
   * @implspec snap?: boolean;
   *
   */
  @JSProperty("snap")
  boolean getSnap();

  /**
   * (Highcharts, Highstock, Highmaps) Whether the crosshair should snap to
   * the point or follow the pointer independent of points.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.snap
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.snap
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.snap
   *
   * @implspec snap?: boolean;
   *
   */
  @JSProperty("snap")
  void setSnap(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) The pixel width of the crosshair.
   * Defaults to 1 for numeric or datetime axes, and for one category width
   * for category axes.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.width
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.width
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.width
   *
   * @implspec width?: number;
   *
   */
  @JSProperty("width")
  double getWidth();

  /**
   * (Highcharts, Highstock, Highmaps) The pixel width of the crosshair.
   * Defaults to 1 for numeric or datetime axes, and for one category width
   * for category axes.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.width
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.width
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.width
   *
   * @implspec width?: number;
   *
   */
  @JSProperty("width")
  void setWidth(double value);

  /**
   * (Highcharts, Highstock, Highmaps) The Z index of the crosshair. Higher Z
   * indices allow drawing the crosshair on top of the series or behind the
   * grid lines.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.zIndex
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.zIndex
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.zIndex
   *
   * @implspec zIndex?: number;
   *
   */
  @JSProperty("zIndex")
  double getZIndex();

  /**
   * (Highcharts, Highstock, Highmaps) The Z index of the crosshair. Higher Z
   * indices allow drawing the crosshair on top of the series or behind the
   * grid lines.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.crosshair.zIndex
   * @see https://api.highcharts.com/highstock/xAxis.crosshair.zIndex
   * @see https://api.highcharts.com/highmaps/xAxis.crosshair.zIndex
   *
   * @implspec zIndex?: number;
   *
   */
  @JSProperty("zIndex")
  void setZIndex(double value);

  /**
   */
  abstract class DashStyle extends JsEnum {
    public static final DashStyle DASH = JsEnum.of("Dash");

    public static final DashStyle DASHDOT = JsEnum.of("DashDot");

    public static final DashStyle DOT = JsEnum.of("Dot");

    public static final DashStyle LONGDASH = JsEnum.of("LongDash");

    public static final DashStyle LONGDASHDOT = JsEnum.of("LongDashDot");

    public static final DashStyle LONGDASHDOTDOT = JsEnum.of("LongDashDotDot");

    public static final DashStyle SHORTDASH = JsEnum.of("ShortDash");

    public static final DashStyle SHORTDASHDOT = JsEnum.of("ShortDashDot");

    public static final DashStyle SHORTDASHDOTDOT = JsEnum.of("ShortDashDotDot");

    public static final DashStyle SHORTDOT = JsEnum.of("ShortDot");

    public static final DashStyle SOLID = JsEnum.of("Solid");
  }
}