com.github.fluorumlabs.disconnect.highcharts.SeriesTreemapDataOptions 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 java.lang.String;
import javax.annotation.Nullable;
import js.lang.Any;
import js.lang.Unknown;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts) An array of data points for the series. For the treemap series
 * type, points can be given in the following ways:
 *
 * 
 * 
 * An array of numerical values. In this case, the numerical values will be
 * interpreted as value options. Example:(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.treemap.data
 *
 */
public interface SeriesTreemapDataOptions extends Any {
  /**
   * (Highcharts, Gantt) An additional, individual class name for the data
   * point's graphic representation.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.className
   * @see https://api.highcharts.com/gantt/series.treemap.data.className
   *
   * @implspec className?: string;
   *
   */
  @JSProperty("className")
  @Nullable
  String getClassName();

  /**
   * (Highcharts, Gantt) An additional, individual class name for the data
   * point's graphic representation.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.className
   * @see https://api.highcharts.com/gantt/series.treemap.data.className
   *
   * @implspec className?: string;
   *
   */
  @JSProperty("className")
  void setClassName(String value);

  /**
   * (Highcharts, Highmaps) The color of the point. In heat maps the point
   * color is rarely set explicitly, as we use the color to denote the
   * value. Options for this are set in the colorAxis configuration.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.color
   * @see https://api.highcharts.com/highmaps/series.treemap.data.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  @Nullable
  Unknown getColor();

  /**
   * (Highcharts, Highmaps) The color of the point. In heat maps the point
   * color is rarely set explicitly, as we use the color to denote the
   * value. Options for this are set in the colorAxis configuration.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.color
   * @see https://api.highcharts.com/highmaps/series.treemap.data.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(GradientColorObject value);

  /**
   * (Highcharts, Highmaps) The color of the point. In heat maps the point
   * color is rarely set explicitly, as we use the color to denote the
   * value. Options for this are set in the colorAxis configuration.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.color
   * @see https://api.highcharts.com/highmaps/series.treemap.data.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(String value);

  /**
   * (Highcharts, Highmaps) The color of the point. In heat maps the point
   * color is rarely set explicitly, as we use the color to denote the
   * value. Options for this are set in the colorAxis configuration.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.color
   * @see https://api.highcharts.com/highmaps/series.treemap.data.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(Any value);

  /**
   * (Highcharts, Gantt) A specific color index to use for the point, so its
   * graphic representations are given the class name highcharts-color-{n}.
   * In styled mode this will change the color of the graphic. In non-styled
   * mode, the color by is set by the fill attribute, so the change in class
   * name won't have a visual effect by default.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.colorIndex
   * @see https://api.highcharts.com/gantt/series.treemap.data.colorIndex
   *
   * @implspec colorIndex?: number;
   *
   */
  @JSProperty("colorIndex")
  double getColorIndex();

  /**
   * (Highcharts, Gantt) A specific color index to use for the point, so its
   * graphic representations are given the class name highcharts-color-{n}.
   * In styled mode this will change the color of the graphic. In non-styled
   * mode, the color by is set by the fill attribute, so the change in class
   * name won't have a visual effect by default.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.colorIndex
   * @see https://api.highcharts.com/gantt/series.treemap.data.colorIndex
   *
   * @implspec colorIndex?: number;
   *
   */
  @JSProperty("colorIndex")
  void setColorIndex(double value);

  /**
   * (Highcharts) Serves a purpose only if a colorAxis object is defined in
   * the chart options. This value will decide which color the point gets from
   * the scale of the colorAxis.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.colorValue
   *
   * @implspec colorValue?: number;
   *
   */
  @JSProperty("colorValue")
  double getColorValue();

  /**
   * (Highcharts) Serves a purpose only if a colorAxis object is defined in
   * the chart options. This value will decide which color the point gets from
   * the scale of the colorAxis.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.colorValue
   *
   * @implspec colorValue?: number;
   *
   */
  @JSProperty("colorValue")
  void setColorValue(double value);

  /**
   * (Highcharts, Highstock, Gantt) Individual data label for each point. The
   * options are the same as the ones for plotOptions.series.dataLabels.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.dataLabels
   * @see https://api.highcharts.com/highstock/series.treemap.data.dataLabels
   * @see https://api.highcharts.com/gantt/series.treemap.data.dataLabels
   *
   * @implspec dataLabels?: PlotSeriesDataLabelsOptions;
   *
   */
  @JSProperty("dataLabels")
  @Nullable
  PlotSeriesDataLabelsOptions getDataLabels();

  /**
   * (Highcharts, Highstock, Gantt) Individual data label for each point. The
   * options are the same as the ones for plotOptions.series.dataLabels.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.dataLabels
   * @see https://api.highcharts.com/highstock/series.treemap.data.dataLabels
   * @see https://api.highcharts.com/gantt/series.treemap.data.dataLabels
   *
   * @implspec dataLabels?: PlotSeriesDataLabelsOptions;
   *
   */
  @JSProperty("dataLabels")
  void setDataLabels(PlotSeriesDataLabelsOptions value);

  /**
   * (Highcharts) A description of the point to add to the screen reader
   * information about the point. Requires the Accessibility module.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.description
   *
   * @implspec description?: string;
   *
   */
  @JSProperty("description")
  @Nullable
  String getDescription();

  /**
   * (Highcharts) A description of the point to add to the screen reader
   * information about the point. Requires the Accessibility module.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.description
   *
   * @implspec description?: string;
   *
   */
  @JSProperty("description")
  void setDescription(String value);

  /**
   * (Highcharts, Highstock, Highmaps) Point specific options for the
   * draggable-points module. Overrides options on series.dragDrop.
   *
   * Requires the draggable-points module.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.dragDrop
   * @see https://api.highcharts.com/highstock/series.treemap.data.dragDrop
   * @see https://api.highcharts.com/highmaps/series.treemap.data.dragDrop
   *
   * @implspec dragDrop?: SeriesTreemapDataDragDropOptions;
   *
   */
  @JSProperty("dragDrop")
  @Nullable
  SeriesTreemapDataDragDropOptions getDragDrop();

  /**
   * (Highcharts, Highstock, Highmaps) Point specific options for the
   * draggable-points module. Overrides options on series.dragDrop.
   *
   * Requires the draggable-points module.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.dragDrop
   * @see https://api.highcharts.com/highstock/series.treemap.data.dragDrop
   * @see https://api.highcharts.com/highmaps/series.treemap.data.dragDrop
   *
   * @implspec dragDrop?: SeriesTreemapDataDragDropOptions;
   *
   */
  @JSProperty("dragDrop")
  void setDragDrop(SeriesTreemapDataDragDropOptions value);

  /**
   * (Highcharts) The id of a series in the drilldown.series array to use
   * for a drilldown for this point.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.drilldown
   *
   * @implspec drilldown?: string;
   *
   */
  @JSProperty("drilldown")
  @Nullable
  String getDrilldown();

  /**
   * (Highcharts) The id of a series in the drilldown.series array to use
   * for a drilldown for this point.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.drilldown
   *
   * @implspec drilldown?: string;
   *
   */
  @JSProperty("drilldown")
  void setDrilldown(String value);

  /**
   * (Highcharts, Highstock, Gantt) Individual point events
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.events
   * @see https://api.highcharts.com/highstock/series.treemap.data.events
   * @see https://api.highcharts.com/gantt/series.treemap.data.events
   *
   * @implspec events?: SeriesTreemapDataEventsOptions;
   *
   */
  @JSProperty("events")
  @Nullable
  SeriesTreemapDataEventsOptions getEvents();

  /**
   * (Highcharts, Highstock, Gantt) Individual point events
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.events
   * @see https://api.highcharts.com/highstock/series.treemap.data.events
   * @see https://api.highcharts.com/gantt/series.treemap.data.events
   *
   * @implspec events?: SeriesTreemapDataEventsOptions;
   *
   */
  @JSProperty("events")
  void setEvents(SeriesTreemapDataEventsOptions value);

  /**
   * (Highcharts, Highstock, Gantt) An id for the point. This can be used
   * after render time to get a pointer to the point object through
   * chart.get().
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.id
   * @see https://api.highcharts.com/highstock/series.treemap.data.id
   * @see https://api.highcharts.com/gantt/series.treemap.data.id
   *
   * @implspec id?: string;
   *
   */
  @JSProperty("id")
  @Nullable
  String getId();

  /**
   * (Highcharts, Highstock, Gantt) An id for the point. This can be used
   * after render time to get a pointer to the point object through
   * chart.get().
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.id
   * @see https://api.highcharts.com/highstock/series.treemap.data.id
   * @see https://api.highcharts.com/gantt/series.treemap.data.id
   *
   * @implspec id?: string;
   *
   */
  @JSProperty("id")
  void setId(String value);

  /**
   * (Highcharts) The rank for this point's data label in case of collision.
   * If two data labels are about to overlap, only the one with the highest
   * labelrank will be drawn.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.labelrank
   *
   * @implspec labelrank?: number;
   *
   */
  @JSProperty("labelrank")
  double getLabelrank();

  /**
   * (Highcharts) The rank for this point's data label in case of collision.
   * If two data labels are about to overlap, only the one with the highest
   * labelrank will be drawn.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.labelrank
   *
   * @implspec labelrank?: number;
   *
   */
  @JSProperty("labelrank")
  void setLabelrank(double value);

  /**
   * (Highcharts) The name of the point as shown in the legend, tooltip,
   * dataLabel etc.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.name
   *
   * @implspec name?: string;
   *
   */
  @JSProperty("name")
  @Nullable
  String getName();

  /**
   * (Highcharts) The name of the point as shown in the legend, tooltip,
   * dataLabel etc.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.name
   *
   * @implspec name?: string;
   *
   */
  @JSProperty("name")
  void setName(String value);

  /**
   * (Highcharts) Only for treemap. Use this option to build a tree structure.
   * The value should be the id of the point which is the parent. If no points
   * has a matching id, or this option is undefined, then the parent will be
   * set to the root.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.parent
   *
   * @implspec parent?: string;
   *
   */
  @JSProperty("parent")
  @Nullable
  String getParent();

  /**
   * (Highcharts) Only for treemap. Use this option to build a tree structure.
   * The value should be the id of the point which is the parent. If no points
   * has a matching id, or this option is undefined, then the parent will be
   * set to the root.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.parent
   *
   * @implspec parent?: string;
   *
   */
  @JSProperty("parent")
  void setParent(String value);

  /**
   * (Highcharts, Highmaps) Point padding for a single point.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.pointPadding
   * @see https://api.highcharts.com/highmaps/series.treemap.data.pointPadding
   *
   * @implspec pointPadding?: number;
   *
   */
  @JSProperty("pointPadding")
  double getPointPadding();

  /**
   * (Highcharts, Highmaps) Point padding for a single point.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.pointPadding
   * @see https://api.highcharts.com/highmaps/series.treemap.data.pointPadding
   *
   * @implspec pointPadding?: number;
   *
   */
  @JSProperty("pointPadding")
  void setPointPadding(double value);

  /**
   * (Highcharts, Highstock, Gantt) Whether the data point is selected
   * initially.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.selected
   * @see https://api.highcharts.com/highstock/series.treemap.data.selected
   * @see https://api.highcharts.com/gantt/series.treemap.data.selected
   *
   * @implspec selected?: boolean;
   *
   */
  @JSProperty("selected")
  boolean getSelected();

  /**
   * (Highcharts, Highstock, Gantt) Whether the data point is selected
   * initially.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.selected
   * @see https://api.highcharts.com/highstock/series.treemap.data.selected
   * @see https://api.highcharts.com/gantt/series.treemap.data.selected
   *
   * @implspec selected?: boolean;
   *
   */
  @JSProperty("selected")
  void setSelected(boolean value);

  /**
   * (Highcharts) The value of the point, resulting in a relative area of the
   * point in the treemap.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.value
   *
   * @implspec value?: number;
   *
   */
  @JSProperty("value")
  double getValue();

  /**
   * (Highcharts) The value of the point, resulting in a relative area of the
   * point in the treemap.
   *
   * @see https://api.highcharts.com/highcharts/series.treemap.data.value
   *
   * @implspec value?: number;
   *
   */
  @JSProperty("value")
  void setValue(double value);
}