com.github.fluorumlabs.disconnect.highcharts.SeriesBoxplotOptions 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.lang.Unknown;
import js.util.collections.Array;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts) A boxplot 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 boxplot series are defined in plotOptions.boxplot.
 *
 * 
 * 
 * Options for one single series are given in the series instance array.
 *
 * 
 * 
 * (see online documentation for example)
 *
 * @see https://api.highcharts.com/highcharts/series.boxplot
 *
 */
public interface SeriesBoxplotOptions extends PlotBoxplotOptions, SeriesOptions {
  /**
   * (Highcharts) An array of data points for the series. For the boxplot
   * series type, points can be given in the following ways:
   *
   * 
   * 
   * An array of arrays with 6 or 5 values. In this case, the values
   * correspond to x,low,q1,median,q3,high. If the first value is a string,
   * it is applied as the name of the point, and the x value is inferred.
   * The x value can also be omitted, in which case the inner arrays should
   * be of length 5. Then the x value is automatically calculated, either
   * starting at 0 and incremented by 1, or from pointStart and
   * pointInterval given in the series options.(see online documentation for
   * example)
   *
   * 
   * 
   * 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.(see online documentation for example)
   *
   * 
   * 
   * @see https://api.highcharts.com/highcharts/series.boxplot.data
   *
   * @implspec data?: Array<([(number|string), number, number, number, number]|[(number|string), number, number, number, number, number]|SeriesBoxplotDataOptions)>;
   *
   */
  @JSProperty("data")
  @Nullable
  Array getData();

  /**
   * (Highcharts) An array of data points for the series. For the boxplot
   * series type, points can be given in the following ways:
   *
   * 
   * 
   * An array of arrays with 6 or 5 values. In this case, the values
   * correspond to x,low,q1,median,q3,high. If the first value is a string,
   * it is applied as the name of the point, and the x value is inferred.
   * The x value can also be omitted, in which case the inner arrays should
   * be of length 5. Then the x value is automatically calculated, either
   * starting at 0 and incremented by 1, or from pointStart and
   * pointInterval given in the series options.(see online documentation for
   * example)
   *
   * 
   * 
   * 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.(see online documentation for example)
   *
   * 
   * 
   * @see https://api.highcharts.com/highcharts/series.boxplot.data
   *
   * @implspec data?: Array<([(number|string), number, number, number, number]|[(number|string), number, number, number, number, number]|SeriesBoxplotDataOptions)>;
   *
   */
  @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: "boxplot";
   *
   */
  @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: "boxplot";
   *
   */
  @JSProperty("type")
  void setType(Type value);

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