com.github.fluorumlabs.disconnect.highcharts.XAxisPlotLinesOptions 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, Gantt) An array of lines stretching across the plot
 * area, marking a specific value on one of the axes.
 *
 * In styled mode, the plot lines are styled by the .highcharts-plot-line
 * class in addition to the className option.
 *
 * @see https://api.highcharts.com/highcharts/xAxis.plotLines
 * @see https://api.highcharts.com/highstock/xAxis.plotLines
 * @see https://api.highcharts.com/gantt/xAxis.plotLines
 *
 */
public interface XAxisPlotLinesOptions extends Any {
  /**
   * (Highcharts, Highstock, Gantt) A custom class name, in addition to the
   * default highcharts-plot-line, to apply to each individual line.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.className
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.className
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.className
   *
   * @implspec className?: string;
   *
   */
  @JSProperty("className")
  @Nullable
  String getClassName();

  /**
   * (Highcharts, Highstock, Gantt) A custom class name, in addition to the
   * default highcharts-plot-line, to apply to each individual line.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.className
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.className
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.className
   *
   * @implspec className?: string;
   *
   */
  @JSProperty("className")
  void setClassName(String value);

  /**
   * (Highcharts, Highstock, Gantt) The color of the line.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.color
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.color
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  @Nullable
  Unknown getColor();

  /**
   * (Highcharts, Highstock, Gantt) The color of the line.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.color
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.color
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(GradientColorObject value);

  /**
   * (Highcharts, Highstock, Gantt) The color of the line.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.color
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.color
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(String value);

  /**
   * (Highcharts, Highstock, Gantt) The color of the line.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.color
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.color
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(Any value);

  /**
   * (Highcharts, Highstock, Gantt) The dashing or dot style for the plot
   * line. For possible values see this overview.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.dashStyle
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.dashStyle
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.dashStyle
   *
   * @implspec dashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
   *
   */
  @JSProperty("dashStyle")
  @Nullable
  DashStyle getDashStyle();

  /**
   * (Highcharts, Highstock, Gantt) The dashing or dot style for the plot
   * line. For possible values see this overview.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.dashStyle
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.dashStyle
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.dashStyle
   *
   * @implspec dashStyle?: ("Dash"|"DashDot"|"Dot"|"LongDash"|"LongDashDot"|"LongDashDotDot"|"ShortDash"|"ShortDashDot"|"ShortDashDotDot"|"ShortDot"|"Solid");
   *
   */
  @JSProperty("dashStyle")
  void setDashStyle(DashStyle value);

  /**
   * (Highcharts, Highstock, Gantt) An object defining mouse events for the
   * plot line. Supported properties are click, mouseover, mouseout,
   * mousemove.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.events
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.events
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.events
   *
   * @implspec events?: any;
   *
   */
  @JSProperty("events")
  @Nullable
  Any getEvents();

  /**
   * (Highcharts, Highstock, Gantt) An object defining mouse events for the
   * plot line. Supported properties are click, mouseover, mouseout,
   * mousemove.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.events
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.events
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.events
   *
   * @implspec events?: any;
   *
   */
  @JSProperty("events")
  void setEvents(Any value);

  /**
   * (Highcharts, Highstock, Gantt) An id used for identifying the plot line
   * in Axis.removePlotLine.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.id
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.id
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.id
   *
   * @implspec id?: string;
   *
   */
  @JSProperty("id")
  @Nullable
  String getId();

  /**
   * (Highcharts, Highstock, Gantt) An id used for identifying the plot line
   * in Axis.removePlotLine.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.id
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.id
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.id
   *
   * @implspec id?: string;
   *
   */
  @JSProperty("id")
  void setId(String value);

  /**
   * (Highcharts, Highstock, Gantt) Text labels for the plot bands
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.label
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.label
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.label
   *
   * @implspec label?: XAxisPlotLinesLabelOptions;
   *
   */
  @JSProperty("label")
  @Nullable
  XAxisPlotLinesLabelOptions getLabel();

  /**
   * (Highcharts, Highstock, Gantt) Text labels for the plot bands
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.label
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.label
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.label
   *
   * @implspec label?: XAxisPlotLinesLabelOptions;
   *
   */
  @JSProperty("label")
  void setLabel(XAxisPlotLinesLabelOptions value);

  /**
   * (Highcharts, Highstock, Gantt) The position of the line in axis units.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.value
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.value
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.value
   *
   * @implspec value?: number;
   *
   */
  @JSProperty("value")
  double getValue();

  /**
   * (Highcharts, Highstock, Gantt) The position of the line in axis units.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.value
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.value
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.value
   *
   * @implspec value?: number;
   *
   */
  @JSProperty("value")
  void setValue(double value);

  /**
   * (Highcharts, Highstock, Gantt) The width or thickness of the plot line.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.width
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.width
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.width
   *
   * @implspec width?: number;
   *
   */
  @JSProperty("width")
  double getWidth();

  /**
   * (Highcharts, Highstock, Gantt) The width or thickness of the plot line.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.width
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.width
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.width
   *
   * @implspec width?: number;
   *
   */
  @JSProperty("width")
  void setWidth(double value);

  /**
   * (Highcharts, Highstock, Gantt) The z index of the plot line within the
   * chart.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.zIndex
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.zIndex
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.zIndex
   *
   * @implspec zIndex?: number;
   *
   */
  @JSProperty("zIndex")
  double getZIndex();

  /**
   * (Highcharts, Highstock, Gantt) The z index of the plot line within the
   * chart.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotLines.zIndex
   * @see https://api.highcharts.com/highstock/xAxis.plotLines.zIndex
   * @see https://api.highcharts.com/gantt/xAxis.plotLines.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");
  }
}