com.github.fluorumlabs.disconnect.highcharts.SeriesScatterDataOptions 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
Show all versions of disconnect-highcharts Show documentation
Highcharts API bindings for Disconnect Zero
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, Highstock) An array of data points for the series. For the
* scatter 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
y options. The x values will be automatically calculated,
* either starting at 0 and incremented by 1, or from pointStart and
* pointInterval given in the series options. If the axis has categories,
* these will be used. Example:(see online documentation for example)
*
*
* -
* An array of arrays with 2 values. In this case, the values correspond to
*
x,y. If the first value is a string, it is applied as the name of the
* point, and the x value is inferred.(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.scatter.data
* @see https://api.highcharts.com/highstock/series.scatter.data
*
*/
public interface SeriesScatterDataOptions extends Any {
/**
* (Highcharts, Gantt) An additional, individual class name for the data
* point's graphic representation.
*
* @see https://api.highcharts.com/highcharts/series.scatter.data.className
* @see https://api.highcharts.com/gantt/series.scatter.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.scatter.data.className
* @see https://api.highcharts.com/gantt/series.scatter.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.scatter.data.color
* @see https://api.highcharts.com/highstock/series.scatter.data.color
* @see https://api.highcharts.com/gantt/series.scatter.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.scatter.data.color
* @see https://api.highcharts.com/highstock/series.scatter.data.color
* @see https://api.highcharts.com/gantt/series.scatter.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.scatter.data.color
* @see https://api.highcharts.com/highstock/series.scatter.data.color
* @see https://api.highcharts.com/gantt/series.scatter.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.scatter.data.color
* @see https://api.highcharts.com/highstock/series.scatter.data.color
* @see https://api.highcharts.com/gantt/series.scatter.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.scatter.data.colorIndex
* @see https://api.highcharts.com/gantt/series.scatter.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.scatter.data.colorIndex
* @see https://api.highcharts.com/gantt/series.scatter.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.scatter.data.dataLabels
* @see https://api.highcharts.com/highstock/series.scatter.data.dataLabels
* @see https://api.highcharts.com/gantt/series.scatter.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.scatter.data.dataLabels
* @see https://api.highcharts.com/highstock/series.scatter.data.dataLabels
* @see https://api.highcharts.com/gantt/series.scatter.data.dataLabels
*
* @implspec dataLabels?: PlotSeriesDataLabelsOptions;
*
*/
@JSProperty("dataLabels")
void setDataLabels(PlotSeriesDataLabelsOptions value);
/**
* (Highcharts, Highstock) 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.scatter.data.description
* @see https://api.highcharts.com/highstock/series.scatter.data.description
*
* @implspec description?: string;
*
*/
@JSProperty("description")
@Nullable
String getDescription();
/**
* (Highcharts, Highstock) 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.scatter.data.description
* @see https://api.highcharts.com/highstock/series.scatter.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.scatter.data.dragDrop
* @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop
* @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop
*
* @implspec dragDrop?: SeriesScatterDataDragDropOptions;
*
*/
@JSProperty("dragDrop")
@Nullable
SeriesScatterDataDragDropOptions 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.scatter.data.dragDrop
* @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop
* @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop
*
* @implspec dragDrop?: SeriesScatterDataDragDropOptions;
*
*/
@JSProperty("dragDrop")
void setDragDrop(SeriesScatterDataDragDropOptions 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.scatter.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.scatter.data.drilldown
*
* @implspec drilldown?: string;
*
*/
@JSProperty("drilldown")
void setDrilldown(String value);
/**
* (Highcharts, Highstock, Gantt) Individual point events
*
* @see https://api.highcharts.com/highcharts/series.scatter.data.events
* @see https://api.highcharts.com/highstock/series.scatter.data.events
* @see https://api.highcharts.com/gantt/series.scatter.data.events
*
* @implspec events?: SeriesScatterDataEventsOptions;
*
*/
@JSProperty("events")
@Nullable
SeriesScatterDataEventsOptions getEvents();
/**
* (Highcharts, Highstock, Gantt) Individual point events
*
* @see https://api.highcharts.com/highcharts/series.scatter.data.events
* @see https://api.highcharts.com/highstock/series.scatter.data.events
* @see https://api.highcharts.com/gantt/series.scatter.data.events
*
* @implspec events?: SeriesScatterDataEventsOptions;
*
*/
@JSProperty("events")
void setEvents(SeriesScatterDataEventsOptions 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.scatter.data.id
* @see https://api.highcharts.com/highstock/series.scatter.data.id
* @see https://api.highcharts.com/gantt/series.scatter.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.scatter.data.id
* @see https://api.highcharts.com/highstock/series.scatter.data.id
* @see https://api.highcharts.com/gantt/series.scatter.data.id
*
* @implspec id?: string;
*
*/
@JSProperty("id")
void setId(String value);
/**
* (Highcharts, Highstock) 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.scatter.data.labelrank
* @see https://api.highcharts.com/highstock/series.scatter.data.labelrank
*
* @implspec labelrank?: number;
*
*/
@JSProperty("labelrank")
double getLabelrank();
/**
* (Highcharts, Highstock) 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.scatter.data.labelrank
* @see https://api.highcharts.com/highstock/series.scatter.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.scatter.data.marker
* @see https://api.highcharts.com/highstock/series.scatter.data.marker
*
* @implspec marker?: SeriesScatterDataMarkerOptions;
*
*/
@JSProperty("marker")
@Nullable
SeriesScatterDataMarkerOptions 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.scatter.data.marker
* @see https://api.highcharts.com/highstock/series.scatter.data.marker
*
* @implspec marker?: SeriesScatterDataMarkerOptions;
*
*/
@JSProperty("marker")
void setMarker(SeriesScatterDataMarkerOptions value);
/**
* (Highcharts, Highstock) The name of the point as shown in the legend,
* tooltip, dataLabel etc.
*
* @see https://api.highcharts.com/highcharts/series.scatter.data.name
* @see https://api.highcharts.com/highstock/series.scatter.data.name
*
* @implspec name?: string;
*
*/
@JSProperty("name")
@Nullable
String getName();
/**
* (Highcharts, Highstock) The name of the point as shown in the legend,
* tooltip, dataLabel etc.
*
* @see https://api.highcharts.com/highcharts/series.scatter.data.name
* @see https://api.highcharts.com/highstock/series.scatter.data.name
*
* @implspec name?: string;
*
*/
@JSProperty("name")
void setName(String value);
/**
* (Highcharts, Highstock, Gantt) Whether the data point is selected
* initially.
*
* @see https://api.highcharts.com/highcharts/series.scatter.data.selected
* @see https://api.highcharts.com/highstock/series.scatter.data.selected
* @see https://api.highcharts.com/gantt/series.scatter.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.scatter.data.selected
* @see https://api.highcharts.com/highstock/series.scatter.data.selected
* @see https://api.highcharts.com/gantt/series.scatter.data.selected
*
* @implspec selected?: boolean;
*
*/
@JSProperty("selected")
void setSelected(boolean value);
/**
* (Highcharts, Highstock) The x value of the point. For datetime axes, the
* X value is the timestamp in milliseconds since 1970.
*
* @see https://api.highcharts.com/highcharts/series.scatter.data.x
* @see https://api.highcharts.com/highstock/series.scatter.data.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
double getX();
/**
* (Highcharts, Highstock) The x value of the point. For datetime axes, the
* X value is the timestamp in milliseconds since 1970.
*
* @see https://api.highcharts.com/highcharts/series.scatter.data.x
* @see https://api.highcharts.com/highstock/series.scatter.data.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
void setX(double value);
/**
* (Highcharts, Highstock) The y value of the point.
*
* @see https://api.highcharts.com/highcharts/series.scatter.data.y
* @see https://api.highcharts.com/highstock/series.scatter.data.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
double getY();
/**
* (Highcharts, Highstock) The y value of the point.
*
* @see https://api.highcharts.com/highcharts/series.scatter.data.y
* @see https://api.highcharts.com/highstock/series.scatter.data.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
void setY(double value);
}