com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.Line Maven / Gradle / Ivy
Show all versions of highcharts Show documentation
package com.github.highcharts4gwt.model.highcharts.option.api.plotoptions;
import com.github.highcharts4gwt.model.array.api.ArrayNumber;
import com.github.highcharts4gwt.model.array.api.ArrayString;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.AfterAnimateHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.CheckboxClickHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.ClickHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.DataLabels;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.HideHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.LegendItemClickHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.Marker;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.MouseOutHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.MouseOverHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.Point;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.ShowHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.States;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.line.Tooltip;
/**
*
*/
public interface Line {
/**
* 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.
*
*/
Line 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.
*
*/
Line 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.
*
*/
Line color(String color);
/**
* Polar charts only. Whether to connect the ends of a line series plot across the extremes.
*
*/
boolean connectEnds();
/**
* Polar charts only. Whether to connect the ends of a line series plot across the extremes.
*
*/
Line connectEnds(boolean connectEnds);
/**
* Whether to connect a graph line across null points.
*
*/
boolean connectNulls();
/**
* Whether to connect a graph line across null points.
*
*/
Line connectNulls(boolean connectNulls);
/**
* 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. .
*
*/
Line 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.
*
*/
Line 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
*
*
*/
Line dashStyle(String dashStyle);
/**
*
*/
DataLabels dataLabels();
/**
*
*/
Line 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.
*
*/
Line enableMouseTracking(boolean enableMouseTracking);
void addAfterAnimateHandler(AfterAnimateHandler afterAnimateHandler);
void addCheckboxClickHandler(CheckboxClickHandler checkboxClickHandler);
void addClickHandler(ClickHandler clickHandler);
void addHideHandler(HideHandler hideHandler);
void addLegendItemClickHandler(LegendItemClickHandler legendItemClickHandler);
void addMouseOutHandler(MouseOutHandler mouseOutHandler);
void addMouseOverHandler(MouseOverHandler mouseOverHandler);
void addShowHandler(ShowHandler showHandler);
/**
* 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.
*
*/
Line keys(ArrayString keys);
/**
* Pixel with of the graph line.
*
*/
double lineWidth();
/**
* Pixel with of the graph line.
*
*/
Line 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.
*
*/
Line linkedTo(String linkedTo);
/**
*
*/
Marker marker();
/**
*
*/
Line marker(Marker marker);
/**
* 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.
*
*/
Line negativeColor(String negativeColor);
/**
* Properties for each single point
*
*/
Point point();
/**
* Properties for each single point
*
*/
Line 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.
*
*/
Line 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.
*
*/
Line pointIntervalUnit(String pointIntervalUnit);
/**
* Possible values: null, "on", "between".
* In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
* Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
* Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.
* Defaults to null in cartesian charts, "between" in polar charts.
*
*/
String pointPlacementAsString();
/**
*
Possible values: null, "on", "between".
* In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
* Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
* Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.
* Defaults to null in cartesian charts, "between" in polar charts.
*
*/
Line pointPlacementAsString(String pointPlacementAsString);
/**
*
Possible values: null, "on", "between".
* In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
* Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
* Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.
* Defaults to null in cartesian charts, "between" in polar charts.
*
*/
double pointPlacementAsNumber();
/**
*
Possible values: null, "on", "between".
* In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
* Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
* Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.
* Defaults to null in cartesian charts, "between" in polar charts.
*
*/
Line pointPlacementAsNumber(double pointPlacementAsNumber);
/**
* 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.
*
*/
Line 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.
*
*/
Line 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.
*
*/
Line 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.
*
*/
Line 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.
*
*/
Line 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.
*
*/
Line showInLegend(boolean showInLegend);
/**
* Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent".
*
*/
String stacking();
/**
* Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent".
*
*/
Line stacking(String stacking);
/**
* A wrapper object for all the series options in specific states.
*
*/
States states();
/**
* A wrapper object for all the series options in specific states.
*
*/
Line states(States states);
/**
* Whether to apply steps to the line. Possible values are left, center and right. Prior to 2.3.5, only left was supported.
*
*/
String step();
/**
* Whether to apply steps to the line. Possible values are left, center and right. Prior to 2.3.5, only left was supported.
*
*/
Line step(String step);
/**
* 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. Defaults to true for line and area type series, but to false for columns, pies etc.
*
*/
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. Defaults to true for line and area type series, but to false for columns, pies etc.
*
*/
Line 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.
*
*/
Line 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.
*
*/
Line 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.
*
*/
Line turboThreshold(double turboThreshold);
/**
* Set the initial visibility of the series.
*
*/
boolean visible();
/**
* Set the initial visibility of the series.
*
*/
Line visible(boolean visible);
/**
* Defines the Axis on which the zones are applied.
*
*/
String zoneAxis();
/**
* Defines the Axis on which the zones are applied.
*
*/
Line zoneAxis(String zoneAxis);
/**
* An array defining zones within a series.
*
*/
ArrayNumber zones();
/**
* An array defining zones within a series.
*
*/
Line zones(ArrayNumber zones);
String getFieldAsJsonObject(String fieldName);
Line setFieldAsJsonObject(String fieldName, String fieldValueAsJonObject);
String getFunctionAsString(String fieldName);
Line setFunctionAsString(String fieldName, String functionAsString);
}