• Home
• com.github.fluorumlabs.disconnect
• disconnect-highcharts
• 0.1.0-alpha1
• source code
• SeriesSankeyDataOptions.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.SeriesSankeyDataOptions 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 org.teavm.jso.JSProperty;

/**
 * (Highcharts) An array of data points for the series. For the sankey series
 * type, points can be given in the following way:
 *
 * 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.sankey.data
 *
 */
public interface SeriesSankeyDataOptions extends Any {
  /**
   * (Highcharts, Gantt) An additional, individual class name for the data
   * point's graphic representation.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.data.className
   * @see https://api.highcharts.com/gantt/series.sankey.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.sankey.data.className
   * @see https://api.highcharts.com/gantt/series.sankey.data.className
   *
   * @implspec className?: string;
   *
   */
  @JSProperty("className")
  void setClassName(String value);

  /**
   * (Highcharts) The color for the individual link. By default, the link
   * color is the same as the node it extends from. The series.fillOpacity
   * option also applies to the points, so when setting a specific link color,
   * consider setting the fillOpacity to 1.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.data.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  @Nullable
  Unknown getColor();

  /**
   * (Highcharts) The color for the individual link. By default, the link
   * color is the same as the node it extends from. The series.fillOpacity
   * option also applies to the points, so when setting a specific link color,
   * consider setting the fillOpacity to 1.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.data.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(GradientColorObject value);

  /**
   * (Highcharts) The color for the individual link. By default, the link
   * color is the same as the node it extends from. The series.fillOpacity
   * option also applies to the points, so when setting a specific link color,
   * consider setting the fillOpacity to 1.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.data.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(String value);

  /**
   * (Highcharts) The color for the individual link. By default, the link
   * color is the same as the node it extends from. The series.fillOpacity
   * option also applies to the points, so when setting a specific link color,
   * consider setting the fillOpacity to 1.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.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.sankey.data.colorIndex
   * @see https://api.highcharts.com/gantt/series.sankey.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.sankey.data.colorIndex
   * @see https://api.highcharts.com/gantt/series.sankey.data.colorIndex
   *
   * @implspec colorIndex?: number;
   *
   */
  @JSProperty("colorIndex")
  void setColorIndex(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.sankey.data.dataLabels
   * @see https://api.highcharts.com/highstock/series.sankey.data.dataLabels
   * @see https://api.highcharts.com/gantt/series.sankey.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.sankey.data.dataLabels
   * @see https://api.highcharts.com/highstock/series.sankey.data.dataLabels
   * @see https://api.highcharts.com/gantt/series.sankey.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.sankey.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.sankey.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.sankey.data.dragDrop
   * @see https://api.highcharts.com/highstock/series.sankey.data.dragDrop
   * @see https://api.highcharts.com/highmaps/series.sankey.data.dragDrop
   *
   * @implspec dragDrop?: SeriesSankeyDataDragDropOptions;
   *
   */
  @JSProperty("dragDrop")
  @Nullable
  SeriesSankeyDataDragDropOptions 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.sankey.data.dragDrop
   * @see https://api.highcharts.com/highstock/series.sankey.data.dragDrop
   * @see https://api.highcharts.com/highmaps/series.sankey.data.dragDrop
   *
   * @implspec dragDrop?: SeriesSankeyDataDragDropOptions;
   *
   */
  @JSProperty("dragDrop")
  void setDragDrop(SeriesSankeyDataDragDropOptions value);

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

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

  /**
   * (Highcharts) The node that the link runs from.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.data.from
   *
   * @implspec from?: string;
   *
   */
  @JSProperty("from")
  @Nullable
  String getFrom();

  /**
   * (Highcharts) The node that the link runs from.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.data.from
   *
   * @implspec from?: string;
   *
   */
  @JSProperty("from")
  void setFrom(String 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.sankey.data.id
   * @see https://api.highcharts.com/highstock/series.sankey.data.id
   * @see https://api.highcharts.com/gantt/series.sankey.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.sankey.data.id
   * @see https://api.highcharts.com/highstock/series.sankey.data.id
   * @see https://api.highcharts.com/gantt/series.sankey.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.sankey.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.sankey.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.sankey.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.sankey.data.name
   *
   * @implspec name?: string;
   *
   */
  @JSProperty("name")
  void setName(String value);

  /**
   * (Highcharts) Whether the link goes out of the system.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.data.outgoing
   *
   * @implspec outgoing?: boolean;
   *
   */
  @JSProperty("outgoing")
  boolean getOutgoing();

  /**
   * (Highcharts) Whether the link goes out of the system.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.data.outgoing
   *
   * @implspec outgoing?: boolean;
   *
   */
  @JSProperty("outgoing")
  void setOutgoing(boolean value);

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

  /**
   * (Highcharts) The node that the link runs to.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.data.to
   *
   * @implspec to?: string;
   *
   */
  @JSProperty("to")
  @Nullable
  String getTo();

  /**
   * (Highcharts) The node that the link runs to.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.data.to
   *
   * @implspec to?: string;
   *
   */
  @JSProperty("to")
  void setTo(String value);

  /**
   * (Highcharts) The weight of the link.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.data.weight
   *
   * @implspec weight?: number;
   *
   */
  @JSProperty("weight")
  double getWeight();

  /**
   * (Highcharts) The weight of the link.
   *
   * @see https://api.highcharts.com/highcharts/series.sankey.data.weight
   *
   * @implspec weight?: number;
   *
   */
  @JSProperty("weight")
  void setWeight(double value);
}