com.github.highcharts4gwt.model.highcharts.option.api.SeriesScatter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of highcharts Show documentation
Show all versions of highcharts Show documentation
GWT wrapper for highcharts library.
package com.github.highcharts4gwt.model.highcharts.option.api;
import com.github.highcharts4gwt.model.array.api.Array;
import com.github.highcharts4gwt.model.array.api.ArrayNumber;
import com.github.highcharts4gwt.model.array.api.ArrayString;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.Data;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.DataLabels;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.Marker;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.Point;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.SeriesScatterAfterAnimateHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.SeriesScatterCheckboxClickHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.SeriesScatterClickHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.SeriesScatterHideHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.SeriesScatterLegendItemClickHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.SeriesScatterMouseOutHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.SeriesScatterMouseOverHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.SeriesScatterShowHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.States;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.Tooltip;
/**
* A scatter series. If the type option is not specified, it is inherited from chart.type.
*
* For options that apply to multiple series, it is recommended to add them to the pointOptions.series options structure. To apply to all series of this specific type, apply it to plotOptions.scatter.
*
*/
public interface SeriesScatter {
/**
* Allow this series' points to be selected by clicking on the markers, bars or pie slices.
*
*/
boolean allowPointSelect();
/**
* Allow this series' points to be selected by clicking on the markers, bars or pie slices.
*
*/
SeriesScatter allowPointSelect(boolean allowPointSelect);
/**
* Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported:
*
* - duration
* - The duration of the animation in milliseconds.
* - easing
* - When using jQuery as the general framework, the easing can be set to
linear or swing. More easing functions are available with the use of jQuery plug-ins, most notably the jQuery UI suite. See the jQuery docs. When using MooTools as the general framework, use the property name transition instead of easing.
*
*
* Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
*
*/
boolean animation();
/**
* Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported:
*
* - duration
* - The duration of the animation in milliseconds.
* - easing
* - When using jQuery as the general framework, the easing can be set to
linear or swing. More easing functions are available with the use of jQuery plug-ins, most notably the jQuery UI suite. See the jQuery docs. When using MooTools as the general framework, use the property name transition instead of easing.
*
*
* Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
*
*/
SeriesScatter animation(boolean animation);
/**
* The main color or the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
*
*/
String color();
/**
* The main color or the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
*
*/
SeriesScatter color(String color);
/**
* When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series. .
*
*/
double cropThreshold();
/**
* When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series. .
*
*/
SeriesScatter cropThreshold(double cropThreshold);
/**
* You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
*
*/
String cursor();
/**
* You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
*
*/
SeriesScatter cursor(String cursor);
/**
* A name for the dash style to use for the graph. Applies only to series type having a graph, like line, spline, area and scatter in case it has a lineWidth. The value for the dashStyle include:
*
* - Solid
* - ShortDash
* - ShortDot
* - ShortDashDot
* - ShortDashDotDot
* - Dot
* - Dash
* - LongDash
* - DashDot
* - LongDashDot
* - LongDashDotDot
*
*
*/
String dashStyle();
/**
* A name for the dash style to use for the graph. Applies only to series type having a graph, like line, spline, area and scatter in case it has a lineWidth. The value for the dashStyle include:
*
* - Solid
* - ShortDash
* - ShortDot
* - ShortDashDot
* - ShortDashDotDot
* - Dot
* - Dash
* - LongDash
* - DashDot
* - LongDashDot
* - LongDashDotDot
*
*
*/
SeriesScatter dashStyle(String dashStyle);
/**
* 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:
* data: [0, 5, 3, 5]
*
* 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.
data: [
* [0, 0],
* [1, 8],
* [2, 9]
* ]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.
*
* data: [{
* x: 1,
* y: 2,
* name: "Point2",
* color: "#00FF00"
* }, {
* x: 1,
* y: 4,
* name: "Point1",
* color: "#FF00FF"
* }]
*
*/
Array dataAsArrayObject();
/**
* 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:
* data: [0, 5, 3, 5]
*
* 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.
data: [
* [0, 0],
* [1, 8],
* [2, 9]
* ]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.
*
* data: [{
* x: 1,
* y: 2,
* name: "Point2",
* color: "#00FF00"
* }, {
* x: 1,
* y: 4,
* name: "Point1",
* color: "#FF00FF"
* }]
*
*/
SeriesScatter dataAsArrayObject(Array dataAsArrayObject);
/**
* 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:
* data: [0, 5, 3, 5]
*
* 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.
data: [
* [0, 0],
* [1, 8],
* [2, 9]
* ]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.
*
* data: [{
* x: 1,
* y: 2,
* name: "Point2",
* color: "#00FF00"
* }, {
* x: 1,
* y: 4,
* name: "Point1",
* color: "#FF00FF"
* }]
*
*/
ArrayNumber dataAsArrayNumber();
/**
* 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:
* data: [0, 5, 3, 5]
*
* 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.
data: [
* [0, 0],
* [1, 8],
* [2, 9]
* ]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.
*
* data: [{
* x: 1,
* y: 2,
* name: "Point2",
* color: "#00FF00"
* }, {
* x: 1,
* y: 4,
* name: "Point1",
* color: "#FF00FF"
* }]
*
*/
SeriesScatter dataAsArrayNumber(ArrayNumber dataAsArrayNumber);
/**
*
*/
DataLabels dataLabels();
/**
*
*/
SeriesScatter dataLabels(DataLabels dataLabels);
/**
* Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
*
*/
boolean enableMouseTracking();
/**
* Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
*
*/
SeriesScatter enableMouseTracking(boolean enableMouseTracking);
void addSeriesScatterAfterAnimateHandler(SeriesScatterAfterAnimateHandler seriesScatterAfterAnimateHandler);
void addSeriesScatterCheckboxClickHandler(SeriesScatterCheckboxClickHandler seriesScatterCheckboxClickHandler);
void addSeriesScatterClickHandler(SeriesScatterClickHandler seriesScatterClickHandler);
void addSeriesScatterHideHandler(SeriesScatterHideHandler seriesScatterHideHandler);
void addSeriesScatterLegendItemClickHandler(SeriesScatterLegendItemClickHandler seriesScatterLegendItemClickHandler);
void addSeriesScatterMouseOutHandler(SeriesScatterMouseOutHandler seriesScatterMouseOutHandler);
void addSeriesScatterMouseOverHandler(SeriesScatterMouseOverHandler seriesScatterMouseOverHandler);
void addSeriesScatterShowHandler(SeriesScatterShowHandler seriesScatterShowHandler);
/**
* An id for the series. This can be used after render time to get a pointer to the series object through chart.get().
*
*/
String id();
/**
* An id for the series. This can be used after render time to get a pointer to the series object through chart.get().
*
*/
SeriesScatter id(String id);
/**
* The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
*
*/
double index();
/**
* The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
*
*/
SeriesScatter index(double index);
/**
* A custom mapping of data point array positions to respective object properties. For example, is the first key is name, the first item in a series.data array is interpreted as point.name.
*
*/
ArrayString keys();
/**
* A custom mapping of data point array positions to respective object properties. For example, is the first key is name, the first item in a series.data array is interpreted as point.name.
*
*/
SeriesScatter keys(ArrayString keys);
/**
* The sequential index of the series in the legend. Try it: Legend in opposite order .
*
*/
double legendIndex();
/**
* The sequential index of the series in the legend. Try it: Legend in opposite order .
*
*/
SeriesScatter legendIndex(double legendIndex);
/**
* The width of the line connecting the data points.
*
*/
double lineWidth();
/**
* The width of the line connecting the data points.
*
*/
SeriesScatter lineWidth(double lineWidth);
/**
* The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
*
*/
String linkedTo();
/**
* The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
*
*/
SeriesScatter linkedTo(String linkedTo);
/**
*
*/
Marker marker();
/**
*
*/
SeriesScatter marker(Marker marker);
/**
* The name of the series as shown in the legend, tooltip etc.
*
*/
String name();
/**
* The name of the series as shown in the legend, tooltip etc.
*
*/
SeriesScatter name(String name);
/**
* The color for the parts of the graph or points that are below the threshold.
*
*/
String negativeColor();
/**
* The color for the parts of the graph or points that are below the threshold.
*
*/
SeriesScatter negativeColor(String negativeColor);
/**
* Properties for each single point
*
*/
Point point();
/**
* Properties for each single point
*
*/
SeriesScatter point(Point point);
/**
* If no x values are given for the points in a series, pointInterval defines
* the interval of the x values. For example, if a series contains one value
* every decade starting from year 0, set pointInterval to 10.
* Since Highcharts 4.1, it can be combined with pointIntervalUnit to draw irregular intervals.
*
*/
double pointInterval();
/**
* If no x values are given for the points in a series, pointInterval defines
* the interval of the x values. For example, if a series contains one value
* every decade starting from year 0, set pointInterval to 10.
* Since Highcharts 4.1, it can be combined with pointIntervalUnit to draw irregular intervals.
*
*/
SeriesScatter pointInterval(double pointInterval);
/**
* On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year. Combine it with pointInterval to draw quarters, 6 months, 10 years etc.
*
*/
String pointIntervalUnit();
/**
* On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year. Combine it with pointInterval to draw quarters, 6 months, 10 years etc.
*
*/
SeriesScatter pointIntervalUnit(String pointIntervalUnit);
/**
* If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
*
*/
double pointStart();
/**
* If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
*
*/
SeriesScatter pointStart(double pointStart);
/**
* Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.
*
*/
boolean selected();
/**
* Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.
*
*/
SeriesScatter selected(boolean selected);
/**
* Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
*
*/
boolean shadowAsBoolean();
/**
* Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
*
*/
SeriesScatter shadowAsBoolean(boolean shadowAsBoolean);
/**
* Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
*
*/
String shadowAsJsonString();
/**
* Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
*
*/
SeriesScatter shadowAsJsonString(String shadowAsJsonString);
/**
* If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
*
*/
boolean showCheckbox();
/**
* If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
*
*/
SeriesScatter showCheckbox(boolean showCheckbox);
/**
* Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
*
*/
boolean showInLegend();
/**
* Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
*
*/
SeriesScatter showInLegend(boolean showInLegend);
/**
* A wrapper object for all the series options in specific states.
*
*/
States states();
/**
* A wrapper object for all the series options in specific states.
*
*/
SeriesScatter states(States states);
/**
* Sticky tracking of mouse events. When true, the mouseOut event
on a series isn't triggered until the mouse moves over another series, or out
of the plot area. When false, the mouseOut event on a series is
triggered when the mouse leaves the area around the series' graph or markers.
This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the
tooltip will be hidden when moving the mouse between series.
*
*/
boolean stickyTracking();
/**
* Sticky tracking of mouse events. When true, the mouseOut event
on a series isn't triggered until the mouse moves over another series, or out
of the plot area. When false, the mouseOut event on a series is
triggered when the mouse leaves the area around the series' graph or markers.
This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the
tooltip will be hidden when moving the mouse between series.
*
*/
SeriesScatter stickyTracking(boolean stickyTracking);
/**
* The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.
*
*/
double threshold();
/**
* The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.
*
*/
SeriesScatter threshold(double threshold);
/**
* A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
*
*/
Tooltip tooltip();
/**
* A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
*
*/
SeriesScatter tooltip(Tooltip tooltip);
/**
* When a series contains a data array that is longer than this, only one dimensional arrays of numbers,
or two dimensional arrays with x and y values are allowed. Also, only the first
point is tested, and the rest are assumed to be the same format. This saves expensive
data checking and indexing in long series. Set it to 0 disable.
*
*/
double turboThreshold();
/**
* When a series contains a data array that is longer than this, only one dimensional arrays of numbers,
or two dimensional arrays with x and y values are allowed. Also, only the first
point is tested, and the rest are assumed to be the same format. This saves expensive
data checking and indexing in long series. Set it to 0 disable.
*
*/
SeriesScatter turboThreshold(double turboThreshold);
/**
* The type of series. Can be one of area, areaspline,
bar, column, line, pie,
scatter or spline. From version 2.3, arearange, areasplinerange and columnrange are supported with the highcharts-more.js component.
*
*/
String type();
/**
* The type of series. Can be one of area, areaspline,
bar, column, line, pie,
scatter or spline. From version 2.3, arearange, areasplinerange and columnrange are supported with the highcharts-more.js component.
*
*/
SeriesScatter type(String type);
/**
* Set the initial visibility of the series.
*
*/
boolean visible();
/**
* Set the initial visibility of the series.
*
*/
SeriesScatter visible(boolean visible);
/**
* When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
*
*/
double xAxisAsNumber();
/**
* When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
*
*/
SeriesScatter xAxisAsNumber(double xAxisAsNumber);
/**
* When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
*
*/
String xAxisAsString();
/**
* When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
*
*/
SeriesScatter xAxisAsString(String xAxisAsString);
/**
* When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.
*
*/
double yAxisAsNumber();
/**
* When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.
*
*/
SeriesScatter yAxisAsNumber(double yAxisAsNumber);
/**
* When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.
*
*/
String yAxisAsString();
/**
* When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.
*
*/
SeriesScatter yAxisAsString(String yAxisAsString);
/**
* Define the visual z index of the series.
*
*/
double zIndex();
/**
* Define the visual z index of the series.
*
*/
SeriesScatter zIndex(double zIndex);
/**
* Defines the Axis on which the zones are applied.
*
*/
String zoneAxis();
/**
* Defines the Axis on which the zones are applied.
*
*/
SeriesScatter zoneAxis(String zoneAxis);
/**
* An array defining zones within a series.
*
*/
ArrayNumber zones();
/**
* An array defining zones within a series.
*
*/
SeriesScatter zones(ArrayNumber zones);
String getFieldAsJsonObject(String fieldName);
SeriesScatter setFieldAsJsonObject(String fieldName, String fieldValueAsJonObject);
String getFunctionAsString(String fieldName);
SeriesScatter setFunctionAsString(String fieldName, String functionAsString);
}