com.github.fluorumlabs.disconnect.highcharts.SeriesTilemapOptions 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, Highmaps) A tilemap 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 tilemap series are defined in plotOptions.tilemap.
 *
 * 
 * 
 * Options for one single series are given in the series instance array.
 *
 * 
 * 
 * (see online documentation for example)
 *
 * @see https://api.highcharts.com/highcharts/series.tilemap
 * @see https://api.highcharts.com/highmaps/series.tilemap
 *
 */
public interface SeriesTilemapOptions extends PlotTilemapOptions, SeriesOptions {
  /**
   * (Highcharts, Highmaps) An array of data points for the series. For the
   * tilemap series type, points can be given in the following ways:
   *
   * 
   * 
   * An array of arrays with 3 or 2 values. In this case, the values
   * correspond to x,y,value. 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
   * 2 . 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 objects are point
   * configuration objects as seen below. If the total number of data points
   * exceeds the series' turboThreshold, this option is not available.(see
   * online documentation for example)
   *
   * 
   * 
   * Note that for some tileShapes the grid coordinates are offset.
   *
   * @see https://api.highcharts.com/highcharts/series.tilemap.data
   * @see https://api.highcharts.com/highmaps/series.tilemap.data
   *
   * @implspec data?: Array<([(number|string), number]|[(number|string), number, number]|SeriesTilemapDataOptions)>;
   *
   */
  @JSProperty("data")
  @Nullable
  Array getData();

  /**
   * (Highcharts, Highmaps) An array of data points for the series. For the
   * tilemap series type, points can be given in the following ways:
   *
   * 
   * 
   * An array of arrays with 3 or 2 values. In this case, the values
   * correspond to x,y,value. 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
   * 2 . 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 objects are point
   * configuration objects as seen below. If the total number of data points
   * exceeds the series' turboThreshold, this option is not available.(see
   * online documentation for example)
   *
   * 
   * 
   * Note that for some tileShapes the grid coordinates are offset.
   *
   * @see https://api.highcharts.com/highcharts/series.tilemap.data
   * @see https://api.highcharts.com/highmaps/series.tilemap.data
   *
   * @implspec data?: Array<([(number|string), number]|[(number|string), number, number]|SeriesTilemapDataOptions)>;
   *
   */
  @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: "tilemap";
   *
   */
  @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: "tilemap";
   *
   */
  @JSProperty("type")
  void setType(Type value);

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