• Home
• com.github.fluorumlabs.disconnect
• disconnect-highcharts
• 0.1.0-alpha1
• source code
• SeriesXrangeDataOptions.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.fluorumlabs.disconnect.highcharts.SeriesXrangeDataOptions Maven / Gradle / Ivy

package com.github.fluorumlabs.disconnect.highcharts;

import java.lang.String;
import javax.annotation.Nullable;
import js.lang.Any;
import js.lang.Unknown;
import js.util.collections.Array;
import org.teavm.jso.JSProperty;

/**
 * (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
 *
 */
public interface SeriesXrangeDataOptions extends Any {
  /**
   * (Highcharts, Gantt) An additional, individual class name for the data
   * point's graphic representation.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.className
   * @see https://api.highcharts.com/gantt/series.xrange.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.xrange.data.className
   * @see https://api.highcharts.com/gantt/series.xrange.data.className
   *
   * @implspec className?: string;
   *
   */
  @JSProperty("className")
  void setClassName(String value);

  /**
   * (Highcharts, Highstock, Gantt) Individual color for the point. By default
   * the color is pulled from the global colors array.
   *
   * In styled mode, the color option doesn't take effect. Instead, use
   * colorIndex.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.color
   * @see https://api.highcharts.com/highstock/series.xrange.data.color
   * @see https://api.highcharts.com/gantt/series.xrange.data.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  @Nullable
  Unknown getColor();

  /**
   * (Highcharts, Highstock, Gantt) Individual color for the point. By default
   * the color is pulled from the global colors array.
   *
   * In styled mode, the color option doesn't take effect. Instead, use
   * colorIndex.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.color
   * @see https://api.highcharts.com/highstock/series.xrange.data.color
   * @see https://api.highcharts.com/gantt/series.xrange.data.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(GradientColorObject value);

  /**
   * (Highcharts, Highstock, Gantt) Individual color for the point. By default
   * the color is pulled from the global colors array.
   *
   * In styled mode, the color option doesn't take effect. Instead, use
   * colorIndex.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.color
   * @see https://api.highcharts.com/highstock/series.xrange.data.color
   * @see https://api.highcharts.com/gantt/series.xrange.data.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(String value);

  /**
   * (Highcharts, Highstock, Gantt) Individual color for the point. By default
   * the color is pulled from the global colors array.
   *
   * In styled mode, the color option doesn't take effect. Instead, use
   * colorIndex.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.color
   * @see https://api.highcharts.com/highstock/series.xrange.data.color
   * @see https://api.highcharts.com/gantt/series.xrange.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.xrange.data.colorIndex
   * @see https://api.highcharts.com/gantt/series.xrange.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.xrange.data.colorIndex
   * @see https://api.highcharts.com/gantt/series.xrange.data.colorIndex
   *
   * @implspec colorIndex?: number;
   *
   */
  @JSProperty("colorIndex")
  void setColorIndex(double value);

  /**
   * (Gantt) Connect to a point. Requires Highcharts Gantt to be loaded. This
   * option can be either a string, referring to the ID of another point, or
   * an object, or an array of either. If the option is an array, each element
   * defines a connection.
   *
   * @see https://api.highcharts.com/gantt/series.xrange.data.connect
   *
   * @implspec connect?: (string|SeriesXrangeDataConnectOptions|Array<(string|SeriesXrangeDataConnectOptions)>);
   *
   */
  @JSProperty("connect")
  @Nullable
  Unknown getConnect();

  /**
   * (Gantt) Connect to a point. Requires Highcharts Gantt to be loaded. This
   * option can be either a string, referring to the ID of another point, or
   * an object, or an array of either. If the option is an array, each element
   * defines a connection.
   *
   * @see https://api.highcharts.com/gantt/series.xrange.data.connect
   *
   * @implspec connect?: (string|SeriesXrangeDataConnectOptions|Array<(string|SeriesXrangeDataConnectOptions)>);
   *
   */
  @JSProperty("connect")
  void setConnect(String value);

  /**
   * (Gantt) Connect to a point. Requires Highcharts Gantt to be loaded. This
   * option can be either a string, referring to the ID of another point, or
   * an object, or an array of either. If the option is an array, each element
   * defines a connection.
   *
   * @see https://api.highcharts.com/gantt/series.xrange.data.connect
   *
   * @implspec connect?: (string|SeriesXrangeDataConnectOptions|Array<(string|SeriesXrangeDataConnectOptions)>);
   *
   */
  @JSProperty("connect")
  void setConnect(SeriesXrangeDataConnectOptions value);

  /**
   * (Gantt) Connect to a point. Requires Highcharts Gantt to be loaded. This
   * option can be either a string, referring to the ID of another point, or
   * an object, or an array of either. If the option is an array, each element
   * defines a connection.
   *
   * @see https://api.highcharts.com/gantt/series.xrange.data.connect
   *
   * @implspec connect?: (string|SeriesXrangeDataConnectOptions|Array<(string|SeriesXrangeDataConnectOptions)>);
   *
   */
  @JSProperty("connect")
  void setConnect(Array 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.xrange.data.dataLabels
   * @see https://api.highcharts.com/highstock/series.xrange.data.dataLabels
   * @see https://api.highcharts.com/gantt/series.xrange.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.xrange.data.dataLabels
   * @see https://api.highcharts.com/highstock/series.xrange.data.dataLabels
   * @see https://api.highcharts.com/gantt/series.xrange.data.dataLabels
   *
   * @implspec dataLabels?: PlotSeriesDataLabelsOptions;
   *
   */
  @JSProperty("dataLabels")
  void setDataLabels(PlotSeriesDataLabelsOptions value);

  /**
   * (Highcharts, Highstock, Gantt) 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.xrange.data.description
   * @see https://api.highcharts.com/highstock/series.xrange.data.description
   * @see https://api.highcharts.com/gantt/series.xrange.data.description
   *
   * @implspec description?: string;
   *
   */
  @JSProperty("description")
  @Nullable
  String getDescription();

  /**
   * (Highcharts, Highstock, Gantt) 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.xrange.data.description
   * @see https://api.highcharts.com/highstock/series.xrange.data.description
   * @see https://api.highcharts.com/gantt/series.xrange.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.xrange.data.dragDrop
   * @see https://api.highcharts.com/highstock/series.xrange.data.dragDrop
   * @see https://api.highcharts.com/highmaps/series.xrange.data.dragDrop
   *
   * @implspec dragDrop?: SeriesXrangeDataDragDropOptions;
   *
   */
  @JSProperty("dragDrop")
  @Nullable
  SeriesXrangeDataDragDropOptions 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.xrange.data.dragDrop
   * @see https://api.highcharts.com/highstock/series.xrange.data.dragDrop
   * @see https://api.highcharts.com/highmaps/series.xrange.data.dragDrop
   *
   * @implspec dragDrop?: SeriesXrangeDataDragDropOptions;
   *
   */
  @JSProperty("dragDrop")
  void setDragDrop(SeriesXrangeDataDragDropOptions 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.xrange.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.xrange.data.drilldown
   *
   * @implspec drilldown?: string;
   *
   */
  @JSProperty("drilldown")
  void setDrilldown(String value);

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

  /**
   * (Highcharts, Highstock, Gantt) Individual point events
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.events
   * @see https://api.highcharts.com/highstock/series.xrange.data.events
   * @see https://api.highcharts.com/gantt/series.xrange.data.events
   *
   * @implspec events?: SeriesXrangeDataEventsOptions;
   *
   */
  @JSProperty("events")
  void setEvents(SeriesXrangeDataEventsOptions 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.xrange.data.id
   * @see https://api.highcharts.com/highstock/series.xrange.data.id
   * @see https://api.highcharts.com/gantt/series.xrange.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.xrange.data.id
   * @see https://api.highcharts.com/highstock/series.xrange.data.id
   * @see https://api.highcharts.com/gantt/series.xrange.data.id
   *
   * @implspec id?: string;
   *
   */
  @JSProperty("id")
  void setId(String value);

  /**
   * (Highcharts, Highstock, Gantt) 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.xrange.data.labelrank
   * @see https://api.highcharts.com/highstock/series.xrange.data.labelrank
   * @see https://api.highcharts.com/gantt/series.xrange.data.labelrank
   *
   * @implspec labelrank?: number;
   *
   */
  @JSProperty("labelrank")
  double getLabelrank();

  /**
   * (Highcharts, Highstock, Gantt) 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.xrange.data.labelrank
   * @see https://api.highcharts.com/highstock/series.xrange.data.labelrank
   * @see https://api.highcharts.com/gantt/series.xrange.data.labelrank
   *
   * @implspec labelrank?: number;
   *
   */
  @JSProperty("labelrank")
  void setLabelrank(double value);

  /**
   * (Highcharts, Highstock) Options for the point markers of line-like
   * series. Properties like fillColor, lineColor and lineWidth define
   * the visual appearance of the markers. Other series types, like column
   * series, don't have markers, but have visual options on the series level
   * instead.
   *
   * In styled mode, the markers can be styled with the .highcharts-point,
   * .highcharts-point-hover and .highcharts-point-select class names.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.marker
   * @see https://api.highcharts.com/highstock/series.xrange.data.marker
   *
   * @implspec marker?: SeriesXrangeDataMarkerOptions;
   *
   */
  @JSProperty("marker")
  @Nullable
  SeriesXrangeDataMarkerOptions getMarker();

  /**
   * (Highcharts, Highstock) Options for the point markers of line-like
   * series. Properties like fillColor, lineColor and lineWidth define
   * the visual appearance of the markers. Other series types, like column
   * series, don't have markers, but have visual options on the series level
   * instead.
   *
   * In styled mode, the markers can be styled with the .highcharts-point,
   * .highcharts-point-hover and .highcharts-point-select class names.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.marker
   * @see https://api.highcharts.com/highstock/series.xrange.data.marker
   *
   * @implspec marker?: SeriesXrangeDataMarkerOptions;
   *
   */
  @JSProperty("marker")
  void setMarker(SeriesXrangeDataMarkerOptions value);

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

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

  /**
   * (Highcharts, Highstock, Gantt) A partial fill for each point, typically
   * used to visualize how much of a task is performed. The partial fill
   * object can be set either on series or point level.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.partialFill
   * @see https://api.highcharts.com/highstock/series.xrange.data.partialFill
   * @see https://api.highcharts.com/gantt/series.xrange.data.partialFill
   *
   * @implspec partialFill?: SeriesXrangeDataPartialFillOptions;
   *
   */
  @JSProperty("partialFill")
  @Nullable
  SeriesXrangeDataPartialFillOptions getPartialFill();

  /**
   * (Highcharts, Highstock, Gantt) A partial fill for each point, typically
   * used to visualize how much of a task is performed. The partial fill
   * object can be set either on series or point level.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.partialFill
   * @see https://api.highcharts.com/highstock/series.xrange.data.partialFill
   * @see https://api.highcharts.com/gantt/series.xrange.data.partialFill
   *
   * @implspec partialFill?: SeriesXrangeDataPartialFillOptions;
   *
   */
  @JSProperty("partialFill")
  void setPartialFill(SeriesXrangeDataPartialFillOptions value);

  /**
   * (Highcharts, Highstock, Gantt) Whether the data point is selected
   * initially.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.selected
   * @see https://api.highcharts.com/highstock/series.xrange.data.selected
   * @see https://api.highcharts.com/gantt/series.xrange.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.xrange.data.selected
   * @see https://api.highcharts.com/highstock/series.xrange.data.selected
   * @see https://api.highcharts.com/gantt/series.xrange.data.selected
   *
   * @implspec selected?: boolean;
   *
   */
  @JSProperty("selected")
  void setSelected(boolean value);

  /**
   * (Highcharts, Highstock, Gantt) The starting X value of the range point.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.x
   * @see https://api.highcharts.com/highstock/series.xrange.data.x
   * @see https://api.highcharts.com/gantt/series.xrange.data.x
   *
   * @implspec x?: number;
   *
   */
  @JSProperty("x")
  double getX();

  /**
   * (Highcharts, Highstock, Gantt) The starting X value of the range point.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.x
   * @see https://api.highcharts.com/highstock/series.xrange.data.x
   * @see https://api.highcharts.com/gantt/series.xrange.data.x
   *
   * @implspec x?: number;
   *
   */
  @JSProperty("x")
  void setX(double value);

  /**
   * (Highcharts, Highstock, Gantt) The ending X value of the range point.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.x2
   * @see https://api.highcharts.com/highstock/series.xrange.data.x2
   * @see https://api.highcharts.com/gantt/series.xrange.data.x2
   *
   * @implspec x2?: number;
   *
   */
  @JSProperty("x2")
  double getX2();

  /**
   * (Highcharts, Highstock, Gantt) The ending X value of the range point.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.x2
   * @see https://api.highcharts.com/highstock/series.xrange.data.x2
   * @see https://api.highcharts.com/gantt/series.xrange.data.x2
   *
   * @implspec x2?: number;
   *
   */
  @JSProperty("x2")
  void setX2(double value);

  /**
   * (Highcharts, Highstock, Gantt) The Y value of the range point.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.y
   * @see https://api.highcharts.com/highstock/series.xrange.data.y
   * @see https://api.highcharts.com/gantt/series.xrange.data.y
   *
   * @implspec y?: number;
   *
   */
  @JSProperty("y")
  double getY();

  /**
   * (Highcharts, Highstock, Gantt) The Y value of the range point.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.y
   * @see https://api.highcharts.com/highstock/series.xrange.data.y
   * @see https://api.highcharts.com/gantt/series.xrange.data.y
   *
   * @implspec y?: number;
   *
   */
  @JSProperty("y")
  void setY(double value);
}