com.github.fluorumlabs.disconnect.highcharts.SeriesFlagsOptions 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;

/**
 * (Highstock) A flags 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 flags series are defined in plotOptions.flags.
 *
 * 
 * 
 * Options for one single series are given in the series instance array.
 *
 * 
 * 
 * (see online documentation for example)
 *
 * @see https://api.highcharts.com/highstock/series.flags
 *
 */
public interface SeriesFlagsOptions extends PlotFlagsOptions, SeriesOptions {
  /**
   * (Highstock) An array of data points for the series. For the flags
   * series type, points can be given in the following ways:
   *
   * 
   * An array of objects with named values. The following snippet shows
   * only a few settings, see the complete options set below. If the total
   * number of data points exceeds the series' turboThreshold, this option is
   * not available.
   * 
   * "B", text: "Second event" }]</pre>
   *
   * @see https://api.highcharts.com/highstock/series.flags.data
   *
   * @implspec data?: Array<SeriesFlagsDataOptions>;
   */
  @JSProperty("data")
  @Nullable
  Array getData();

  /**
   * (Highstock) An array of data points for the series. For the flags
   * series type, points can be given in the following ways:
   *
   * 
   * An array of objects with named values. The following snippet shows
   * only a few settings, see the complete options set below. If the total
   * number of data points exceeds the series' turboThreshold, this option is
   * not available.
   * 
   * "B", text: "Second event" }]</pre>
   *
   * @see https://api.highcharts.com/highstock/series.flags.data
   *
   * @implspec data?: Array<SeriesFlagsDataOptions>;
   */
  @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: "flags";
   *
   */
  @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: "flags";
   *
   */
  @JSProperty("type")
  void setType(Type value);

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