• Home
• com.github.fluorumlabs.disconnect
• disconnect-highcharts
• 0.1.0-alpha1
• source code
• XAxisPlotBandsOptions.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

package com.github.fluorumlabs.disconnect.highcharts;

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

/**
 * (Highcharts, Highstock, Gantt) An array of colored bands stretching across
 * the plot area marking an interval on the axis.
 *
 * In styled mode, the plot bands are styled by the .highcharts-plot-band
 * class in addition to the className option.
 *
 * @see https://api.highcharts.com/highcharts/xAxis.plotBands
 * @see https://api.highcharts.com/highstock/xAxis.plotBands
 * @see https://api.highcharts.com/gantt/xAxis.plotBands
 *
 */
public interface XAxisPlotBandsOptions extends Any {
  /**
   * (Highcharts, Highstock, Gantt) Border color for the plot band. Also
   * requires borderWidth to be set.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotBands.borderColor
   * @see https://api.highcharts.com/highstock/xAxis.plotBands.borderColor
   * @see https://api.highcharts.com/gantt/xAxis.plotBands.borderColor
   *
   * @implspec borderColor?: ColorString;
   *
   */
  @JSProperty("borderColor")
  @Nullable
  String getBorderColor();

  /**
   * (Highcharts, Highstock, Gantt) Border color for the plot band. Also
   * requires borderWidth to be set.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotBands.borderColor
   * @see https://api.highcharts.com/highstock/xAxis.plotBands.borderColor
   * @see https://api.highcharts.com/gantt/xAxis.plotBands.borderColor
   *
   * @implspec borderColor?: ColorString;
   *
   */
  @JSProperty("borderColor")
  void setBorderColor(String value);

  /**
   * (Highcharts, Highstock, Gantt) Border width for the plot band. Also
   * requires borderColor to be set.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotBands.borderWidth
   * @see https://api.highcharts.com/highstock/xAxis.plotBands.borderWidth
   * @see https://api.highcharts.com/gantt/xAxis.plotBands.borderWidth
   *
   * @implspec borderWidth?: number;
   *
   */
  @JSProperty("borderWidth")
  double getBorderWidth();

  /**
   * (Highcharts, Highstock, Gantt) Border width for the plot band. Also
   * requires borderColor to be set.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotBands.borderWidth
   * @see https://api.highcharts.com/highstock/xAxis.plotBands.borderWidth
   * @see https://api.highcharts.com/gantt/xAxis.plotBands.borderWidth
   *
   * @implspec borderWidth?: number;
   *
   */
  @JSProperty("borderWidth")
  void setBorderWidth(double value);

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

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

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

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

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

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

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

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

  /**
   * (Highcharts, Highstock, Gantt) The start position of the plot band in
   * axis units.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotBands.from
   * @see https://api.highcharts.com/highstock/xAxis.plotBands.from
   * @see https://api.highcharts.com/gantt/xAxis.plotBands.from
   *
   * @implspec from?: number;
   *
   */
  @JSProperty("from")
  double getFrom();

  /**
   * (Highcharts, Highstock, Gantt) The start position of the plot band in
   * axis units.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotBands.from
   * @see https://api.highcharts.com/highstock/xAxis.plotBands.from
   * @see https://api.highcharts.com/gantt/xAxis.plotBands.from
   *
   * @implspec from?: number;
   *
   */
  @JSProperty("from")
  void setFrom(double value);

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

  /**
   * (Highcharts, Highstock, Gantt) An id used for identifying the plot band
   * in Axis.removePlotBand.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotBands.id
   * @see https://api.highcharts.com/highstock/xAxis.plotBands.id
   * @see https://api.highcharts.com/gantt/xAxis.plotBands.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.plotBands.label
   * @see https://api.highcharts.com/highstock/xAxis.plotBands.label
   * @see https://api.highcharts.com/gantt/xAxis.plotBands.label
   *
   * @implspec label?: XAxisPlotBandsLabelOptions;
   *
   */
  @JSProperty("label")
  @Nullable
  XAxisPlotBandsLabelOptions getLabel();

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

  /**
   * (Highcharts, Highstock, Gantt) The end position of the plot band in axis
   * units.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotBands.to
   * @see https://api.highcharts.com/highstock/xAxis.plotBands.to
   * @see https://api.highcharts.com/gantt/xAxis.plotBands.to
   *
   * @implspec to?: number;
   *
   */
  @JSProperty("to")
  double getTo();

  /**
   * (Highcharts, Highstock, Gantt) The end position of the plot band in axis
   * units.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotBands.to
   * @see https://api.highcharts.com/highstock/xAxis.plotBands.to
   * @see https://api.highcharts.com/gantt/xAxis.plotBands.to
   *
   * @implspec to?: number;
   *
   */
  @JSProperty("to")
  void setTo(double value);

  /**
   * (Highcharts, Highstock, Gantt) The z index of the plot band within the
   * chart, relative to other elements. Using the same z index as another
   * element may give unpredictable results, as the last rendered element will
   * be on top. Values from 0 to 20 make sense.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotBands.zIndex
   * @see https://api.highcharts.com/highstock/xAxis.plotBands.zIndex
   * @see https://api.highcharts.com/gantt/xAxis.plotBands.zIndex
   *
   * @implspec zIndex?: number;
   *
   */
  @JSProperty("zIndex")
  double getZIndex();

  /**
   * (Highcharts, Highstock, Gantt) The z index of the plot band within the
   * chart, relative to other elements. Using the same z index as another
   * element may give unpredictable results, as the last rendered element will
   * be on top. Values from 0 to 20 make sense.
   *
   * @see https://api.highcharts.com/highcharts/xAxis.plotBands.zIndex
   * @see https://api.highcharts.com/highstock/xAxis.plotBands.zIndex
   * @see https://api.highcharts.com/gantt/xAxis.plotBands.zIndex
   *
   * @implspec zIndex?: number;
   *
   */
  @JSProperty("zIndex")
  void setZIndex(double value);
}