com.github.fluorumlabs.disconnect.highcharts.SeriesXrangeOptions 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 javax.annotation.Nullable;
import js.extras.JsEnum;
import js.util.collections.Array;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Gantt) An xrange series. If the type option is not
 * specified, it is inherited from chart.type.
 *
 * Configuration options for the series are given in three levels:
 *
 * 
 * 
 * Options for all series in a chart are defined in the plotOptions.series
 * object.
 *
 * 
 * 
 * Options for all xrange series are defined in plotOptions.xrange.
 *
 * 
 * 
 * Options for one single series are given in the series instance array.
 *
 * 
 * 
 * (see online documentation for example)
 *
 * @see https://api.highcharts.com/highcharts/series.xrange
 * @see https://api.highcharts.com/highstock/series.xrange
 * @see https://api.highcharts.com/gantt/series.xrange
 *
 */
public interface SeriesXrangeOptions extends PlotXrangeOptions, SeriesOptions {
  /**
   * (Highcharts, Highstock, Gantt) An array of data points for the series.
   * For the xrange series type, points can be given in the following ways:
   *
   * 
   * An array of objects with named values. The objects are point
   * configuration objects as seen below.(see online documentation for
   * example)
   * 
   * @see https://api.highcharts.com/highcharts/series.xrange.data
   * @see https://api.highcharts.com/highstock/series.xrange.data
   * @see https://api.highcharts.com/gantt/series.xrange.data
   *
   * @implspec data?: Array;
   *
   */
  @JSProperty("data")
  @Nullable
  Array getData();

  /**
   * (Highcharts, Highstock, Gantt) An array of data points for the series.
   * For the xrange series type, points can be given in the following ways:
   *
   * 
   * An array of objects with named values. The objects are point
   * configuration objects as seen below.(see online documentation for
   * example)
   * 
   * @see https://api.highcharts.com/highcharts/series.xrange.data
   * @see https://api.highcharts.com/highstock/series.xrange.data
   * @see https://api.highcharts.com/gantt/series.xrange.data
   *
   * @implspec data?: Array;
   *
   */
  @JSProperty("data")
  void setData(Array value);

  /**
   * (Highcharts, Highstock, Highmaps) This property is only in TypeScript
   * non-optional and might be undefined in series objects from unknown
   * sources.
   *
   * @implspec type: "xrange";
   *
   */
  @JSProperty("type")
  Type getType();

  /**
   * (Highcharts, Highstock, Highmaps) This property is only in TypeScript
   * non-optional and might be undefined in series objects from unknown
   * sources.
   *
   * @implspec type: "xrange";
   *
   */
  @JSProperty("type")
  void setType(Type value);

  /**
   */
  abstract class Type extends JsEnum {
    public static final Type XRANGE = JsEnum.of("xrange");
  }
}