org.moxieapps.gwt.highcharts.client.plotOptions

Class PlotOptions<T extends PlotOptions>

java.lang.Object

org.moxieapps.gwt.highcharts.client.Configurable<T>

org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions<T>

Direct Known Subclasses:

BarPlotOptions, BaseAreaPlotOptions, BaseAreaSplinePlotOptions, BaseColumnPlotOptions, BaseGaugePlotOptions, BaseMapOptions, BaseProportionalPlotOptions, BubblePlotOptions, CandlestickPlotOptions, FlagPlotOptions, LinePlotOptions, OHLCPlotOptions, ScatterPlotOptions, SeriesPlotOptions, SplinePlotOptions, WaterfallPlotOptions

public abstract class PlotOptions<T extends PlotOptions>
extends Configurable<T>

Represents the base class of all PlotOptions types. This class should not be used directly, but instead use one of the sub types such as AreaPlotOptions, BarPlotOptions, etc. Note that general plot options that should apply to all series can be set using the SeriesPlotOptions. Also note that plot options can be overridden on each individual series via the Series.setPlotOptions(PlotOptions) mechanism.

Since:

1.0.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlotOptions.Cursor An enumeration of supported cursor types, which can be passed to the setCursor(org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions.Cursor) method.
static class	PlotOptions.PointPlacement An enumeration of the supported placement types, which can be passed to the setPointPlacement(org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions.PointPlacement) method.
static class	PlotOptions.Stacking An enumeration of supported stacking types, which can be passed to the setStacking(PlotOptions.Stacking) method.

Constructor Summary

Constructors

Constructor and Description
PlotOptions()

Method Summary

Methods

Modifier and Type	Method and Description
BaseDataLabels	getDataLabels() Returns a reference to the data labels configuration that was set on this plot options, or null if none were set.
T	setAllowPointSelect(boolean allowPointSelect) Convenience method for setting the 'allowPointSelect' plot option.
T	setAnimation(Animation animation) Convenience method for setting the 'animation' plot option, controlling the details of the animation more precisely.
T	setAnimation(boolean animation) Convenience method for setting the 'animation' plot option.
protected T	setBaseDataLabels(BaseDataLabels baseDataLabels)
T	setColor(Color color) Convenience method for setting the 'color' plot option to a gradient or color with an alpha value.
T	setColor(String color) Convenience method for setting the 'color' plot option to an RGB value.
T	setCropThreshold(Number cropThreshold) Convenience method for setting the 'cropThreshold' option.
T	setCursor(PlotOptions.Cursor cursor) Convenience method for setting the 'cursor' plot option.
T	setDashStyle(PlotLine.DashStyle dashStyle) Convenience method for setting the 'dashStyle' plot option.
T	setDataGrouping(DataGrouping dataGrouping) Convenience method for setting the "dataGrouping" options for a stock chart.
T	setDataLabels(DataLabels dataLabels) Convenience method for setting the 'dataLabels' plot option.
T	setEnableMouseTracking(boolean enableMouseTracking) Convenience method for setting the 'enableMouseTracking' plot option.
T	setHoverStateEnabled(boolean enabled) Convenience method for setting the 'enabled' plot option for the hover state.
T	setHoverStateLineWidth(Number lineWidth) Convenience method for setting the 'lineWidth' plot option for the hover state.
T	setHoverStateMarker(Marker marker) Convenience method for setting the 'marker' plot options for the hover state.
T	setId(String id) Convenience method for setting the 'id' option of the chart.
T	setLegendIndex(int legendIndex) Convenience method for setting the 'legendIndex' option of the plot options.
T	setLineWidth(Number lineWidth) Convenience method for setting the 'lineWidth' plot option.
T	setLinkedTo(Series series) convenience method for setting the "linkedTo" option.
T	setLinkedTo(String linkedTo) convenience method for setting the "linkedTo" option.
T	setMarker(Marker marker) Convenience method for setting the 'marker' plot options.
PlotOptions	setNegativeColor(Color negativeColor) Convenience method for setting the "negativeColor" option for the plot options.
PlotOptions	setNegativeColor(String negativeColor) Convenience method for setting the "negativeColor" option for the plot options.
T	setPointInterval(Number pointInterval) Convenience method for setting the 'pointInterval' plot option.
T	setPointPlacement(PlotOptions.PointPlacement pointPointPlacement) Convenience method for setting the 'pointPointPlacement' plot option.
T	setPointStart(Number pointStart) Convenience method for setting the 'pointStart' plot option.
T	setSelected(boolean selected) Convenience method for setting the 'selected' plot option.
T	setShadow(boolean shadow) Convenience method for setting the 'shadow' plot option.
T	setShowCheckbox(boolean showCheckbox) Convenience method for setting the 'showCheckbox' plot option.
T	setShowInLegend(boolean showInLegend) Convenience method for setting the 'showInLegend' plot option.
T	setStacking(PlotOptions.Stacking stacking) Convenience method for setting the 'stacking' plot option.
T	setStickyTracking(boolean stickyTracking) Convenience method for setting the 'stickyTracking' plot option.
T	setThreshold(Number threshold) Convenience method for setting the "threshold" option for the plot options.
T	setTurboThreshold(Number turboThreshold) Convenience method for setting the "turboThreshold" optioin for the plot options.
T	setVisible(boolean visible) Convenience method for setting the 'visible' plot option.
T	setZIndex(Number zIndex) Convenience method for setting the 'zIndex' plot option.
T	setZoneAxis(Zone.Axis zoneAxis) Convenience method for setting the 'zoneAxis' plot option.
T	setZones(Zone... zones) Convenience method for setting the 'zone' plot option.

Methods inherited from class org.moxieapps.gwt.highcharts.client.Configurable

getOptions, setOption

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlotOptions

public PlotOptions()

Method Detail

setAllowPointSelect

public T setAllowPointSelect(boolean allowPointSelect)

Convenience method for setting the 'allowPointSelect' plot option. Equivalent to:

     plotOptions.setOption("allowPointSelect", true);
 

Allow the series' points to be selected by clicking on the markers, bars or pie slices. Defaults to false.

Parameters:

allowPointSelect - 'true' to allow the series' points to be selected by clicking on the markers.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setAnimation

public T setAnimation(boolean animation)

Convenience method for setting the 'animation' plot option. Equivalent to:

     plotOptions.setOption("animation", true);
 

Enable or disable the initial animation when a series is displayed. Note that for more control over the way the series display animations will occurs utils the setAnimation(org.moxieapps.gwt.highcharts.client.Animation) method instead.

Parameters:

animation - 'true' to animate series when they are added to the chart

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setAnimation

public T setAnimation(Animation animation)

Convenience method for setting the 'animation' plot option, controlling the details of the animation more precisely. Equivalent to:

 plotOptions.setOption("/animation/duration", 500);
 plotOptions.setOption("/animation/easing", "linear");
 

Note that this is intended for users that want to have finite control over the way animations behave. To simply enable/disable animations, you can use the setAnimation(boolean) method instead.

Parameters:

animation - The custom animation to set as the default animation type for the chart.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setColor

public T setColor(String color)

Convenience method for setting the 'color' plot option to an RGB value. Equivalent to:

     plotOptions.setOption("color", "#CC0000");
 

The main color of 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.

Note that this method is intended for setting the color to a simple RBG hex value. If you instead want to set a color to include an alpha channel or a gradient, use the setColor(Color) version instead.

Also note that the default colors for all of the series in the chart can be set via the BaseChart.setColors(String...) method.

Parameters:

color - The color to use for this series (e.g. "#CC0000")

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setColor

public T setColor(Color color)

Convenience method for setting the 'color' plot option to a gradient or color with an alpha value. Equivalent to:

     chart.setOption("color", new Color()
        .setLinearGradient(0.0, 0.0, 1.0, 1.0)
        .addStop(new Color(255, 255, 255))
        .addStop(new Color(200, 200, 255))
     );
 

The main color of the series as a gradient or color with an alpha channel. 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.

Note that this method is intended for setting the color to a gradient or color that includes an alpha channel. If you instead just want to set the color to a normal RGB hex value you can use the setColor(String) version instead.

Also note that the default colors for all of the series in the chart can be set via the BaseChart.setColors(String...) method.

Parameters:

color - The color to use for this series (e.g. "#CC0000")

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setCropThreshold

public T setCropThreshold(Number cropThreshold)

Convenience method for setting the 'cropThreshold' option. Equivalent to:

     plotOptions.setOption("crpThreshold", 25);
 

When the series contains less points than the crop threshold, all points are drawn, even 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. Defaults to 50.

Parameters:

cropThreshold - The limit of points to be displayed at any one time

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setCursor

public T setCursor(PlotOptions.Cursor cursor)

Convenience method for setting the 'cursor' plot option. Equivalent to:

     plotOptions.setOption("cursor", PlotOptions.Cursor.POINTER);
 

Tou 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. Defaults to PlotOptions.Cursor.NONE.

Parameters:

cursor - The color to use for this series (e.g. "#CC0000"), or null to use the default.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setDashStyle

public T setDashStyle(PlotLine.DashStyle dashStyle)

Convenience method for setting the 'dashStyle' plot option. Equivalent to:

     plotOptions.setOption("dashStyle", PlotOptions.DashStyle.DOT);
 

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. See this demonstration for a visible reference of the available dash styles.

Parameters:

dashStyle - The dash style to use for this series, or null to use the default.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setDataLabels

public T setDataLabels(DataLabels dataLabels)

Convenience method for setting the 'dataLabels' plot option. Equivalent to:

 plotOptions.setOption("/dataLabels/enabled", true);
 plotOptions.setOption("/dataLabels/align", Labels.Align.CENTER);
 plotOptions.setOption("/dataLabels/color", "#CC0000");
 etc...
 

Defines the appearance of the data labels, static labels for each point.

Sample usage:

 plotOptions.setDataLabels(
     new DataLabels()
        .setColor("#FF0000")
 );
 

Parameters:

dataLabels - The configuration of how the data labels should appear.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setBaseDataLabels

protected T setBaseDataLabels(BaseDataLabels baseDataLabels)

setDataGrouping

public T setDataGrouping(DataGrouping dataGrouping)

Convenience method for setting the "dataGrouping" options for a stock chart. Sample usage:

     plotOptions.setDataGrouping(
         new DataGrouping()
             .setEnabled(true);
     );
 

Parameters:

dataGrouping - The dataGrouping options set using DataGrouping

Returns:

A reference to this PlotOptions for convenient method chaining.

Since:

1.6.0

getDataLabels

public BaseDataLabels getDataLabels()

Returns a reference to the data labels configuration that was set on this plot options, or null if none were set. Note that this method returns an BaseDataLabels and not simply a DataLabels in order to handle alternative labels types such as ProportionalDataLabels.

Returns:

A reference to the data labels configuration that was set on this plot options, or null if none was set.

setEnableMouseTracking

public T setEnableMouseTracking(boolean enableMouseTracking)

Convenience method for setting the 'enableMouseTracking' plot option. Equivalent to:

     plotOptions.setOption("enableMouseTracking", false);
 

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. Defaults to true.

Parameters:

enableMouseTracking - Enable or disable the mouse tracking for a specific series.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setId

public T setId(String id)

Convenience method for setting the 'id' option of the chart. Equivalent to:

     chart.setOption("id", "chart");
 

This can be used after render time to get a pointer to the series object through chart.get().

Parameters:

id - An id for the series.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

Since:

1.6.0

setLegendIndex

public T setLegendIndex(int legendIndex)

Convenience method for setting the 'legendIndex' option of the plot options. Equivalent to:

     plotOptions.setOption("legendIndex", 3);
 

The sequential index of the series in the legend. Series default to being added to the legend in the same index as they are added to the chart.

Parameters:

legendIndex - The sequential index of the series in the legend.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

Since:

1.4.0

setLineWidth

public T setLineWidth(Number lineWidth)

Convenience method for setting the 'lineWidth' plot option. Equivalent to:

     plotOptions.setOption("lineWidth", 4);
 

Pixel with of the graph line. Defaults to 2.

Parameters:

lineWidth - Pixel with of the graph line.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setLinkedTo

public T setLinkedTo(String linkedTo)

convenience method for setting the "linkedTo" option. Equivalent to:

     plotOptions.setOption("linkedTo", "seriesId");
 

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.

Note: this method will set a link to another series based on its id. To link to the series itself instead of its id, use setLinkedTo(Series)

Parameters:

linkedTo - The name of the series to be linked to.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

Since:

1.6.0

See Also:

setLinkedTo(Series)

setLinkedTo

public T setLinkedTo(Series series)

convenience method for setting the "linkedTo" option. Equivalent to:

     plotOptions.setOption("linkedTo", "seriesId");
 

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.

Parameters:

series - The name of the series to be linked to.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

Since:

1.6.0

See Also:

setLinkedTo(String)

setMarker

public T setMarker(Marker marker)

Convenience method for setting the 'marker' plot options. Equivalent to:

 plotOptions.setOption("/marker/enabled", true);
 plotOptions.setOption("/marker/fillColor", "#CCCCCC");
 plotOptions.setOption("/dataLabels/radius", 4);
 etc...
 

Defines the appearance of the markers drawn for this series.

Parameters:

marker - The configuration of how the series markers should appear.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setNegativeColor

public PlotOptions setNegativeColor(Color negativeColor)

Convenience method for setting the "negativeColor" option for the plot options. Equivalent to:

     areaPlotOptions.setOption("negativeColor", new Color()
        .setLinearGradient(0.0, 0.0, 1.0, 1.0)
        .addStop(new Color(255, 255, 255))
        .addStop(new Color(200, 200, 255))
     );
 

When a point's Z value is below the zThreshold setting, this color is used. Defaults to null.

Note that this method is intended for setting the color to a gradient or color that includes an alpha channel. If you instead just want to set the color to a normal RGB hex value you can use the setNegativeColor(String) version instead.

Parameters:

negativeColor - The color for the parts of the graph or points that are below the threshold.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

Since:

1.6.0

setNegativeColor

public PlotOptions setNegativeColor(String negativeColor)

Convenience method for setting the "negativeColor" option for the plot options. Equivalent to:

     PlotOptions.setOptions("negativeColor", "#CCCCCC");
 

When a point's Z value is below the zThreshold setting, this color is used. Defaults to null.

Note that this method is intended for setting the color to a simple RBG hex value. If you instead want to set a color to include an alpha channel or a gradient, use the setNegativeColor(Color) version instead.

Parameters:

negativeColor - The color for the parts of the graph or points that are below the threshold.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

Since:

1.6.0

setPointStart

public T setPointStart(Number pointStart)

Convenience method for setting the 'pointStart' plot option. Equivalent to:

     plotOptions.setOption("pointStart", 10);
 

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. Defaults to 0.

Parameters:

pointStart - Which value to start the series at.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setPointInterval

public T setPointInterval(Number pointInterval)

Convenience method for setting the 'pointInterval' plot option. Equivalent to:

     plotOptions.setOption("pointInterval", 5);
 

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.

Parameters:

pointInterval - The interval of the x value in the series.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setPointPlacement

public T setPointPlacement(PlotOptions.PointPlacement pointPointPlacement)

Convenience method for setting the 'pointPointPlacement' plot option. Equivalent to:

     plotOptions.setOption("pointPointPlacement", Stacking.NULL);
 

Possible values: null, "on", "between".

In a column chart, when pointPointPlacement 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 pointPointPlacement 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.

Defaults to null in cartesian charts, "between" in polar charts.

Parameters:

pointPointPlacement - Where to place points in relation to ticks on the axis.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

Since:

1.6.0

setSelected

public T setSelected(boolean selected)

Convenience method for setting the 'selected' plot option. Equivalent to:

     plotOptions.setOption("selected", true);
 

Whether to select the series initially. If setShowCheckbox(boolean) is true, the checkbox next to the series name will be checked for a selected series. Defaults to false.

Parameters:

selected - Whether to select the series initially.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setShadow

public T setShadow(boolean shadow)

Convenience method for setting the 'shadow' plot option. Equivalent to:

     plotOptions.setOption("shadow", false);
 

Whether to apply a drop shadow to the graph line. Defaults to true.

Parameters:

shadow - Whether to apply a drop shadow to the graph line.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setShowCheckbox

public T setShowCheckbox(boolean showCheckbox)

Convenience method for setting the 'showCheckbox' plot option. Equivalent to:

     plotOptions.setOption("showCheckbox", true);
 

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. Defaults to false.

Parameters:

showCheckbox - Whether to display next to the legend item to allow selecting the series.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setShowInLegend

public T setShowInLegend(boolean showInLegend)

Convenience method for setting the 'showInLegend' plot option. Equivalent to:

     plotOptions.setOption("showInLegend", false);
 

Whether to display this particular series or series type in the legend. Defaults to true.

Parameters:

showInLegend - Whether to display this particular series or series type in the legend.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setStacking

public T setStacking(PlotOptions.Stacking stacking)

Convenience method for setting the 'stacking' plot option. Equivalent to:

     plotOptions.setOption("stacking", Stacking.NORMAL);
 

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". Defaults to null.

Parameters:

stacking - Whether to stack the values of each series on top of each other.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setHoverStateEnabled

public T setHoverStateEnabled(boolean enabled)

Convenience method for setting the 'enabled' plot option for the hover state. Equivalent to:

     plotOptions.setOption("/states/hover/enable", true);
 

Enable separate styles for the hovered series to visualize that the user hovers either the series itself or the legend. Enabling it has a performance penalty as it requires that a second layer be drawn as a double buffer. This means twice as much graphics to draw for each plot, which can make a great difference for charts with a high number of series or points. Defaults to false.

Parameters:

enabled - Whether to enable separate styles for the hover state.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setHoverStateLineWidth

public T setHoverStateLineWidth(Number lineWidth)

Convenience method for setting the 'lineWidth' plot option for the hover state. Equivalent to:

     plotOptions.setOption("/states/hover/lineWidth", 4);
 

Pixel with of the graph line when hovered over. Defaults to 2.

Parameters:

lineWidth - Pixel with of the graph line when hovered over.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setHoverStateMarker

public T setHoverStateMarker(Marker marker)

Convenience method for setting the 'marker' plot options for the hover state. Equivalent to:

 plotOptions.setOption("/states/hover/marker/enabled", true);
 plotOptions.setOption("/states/hover/marker/fillColor", "#CCCCCC");
 plotOptions.setOption("/states/hover/dataLabels/radius", 4);
 etc...
 

Defines the appearance of the markers drawn for this series when hovered over. Note that the hover state need to be enabled with the setHoverStateEnabled(boolean) method in order for this option to have any effect.

Parameters:

marker - The configuration of how the series markers should appear when hover over.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setStickyTracking

public T setStickyTracking(boolean stickyTracking)

Convenience method for setting the 'stickyTracking' plot option. Equivalent to:

     plotOptions.setOption("stickyTracking", false);
 

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, the tooltip will be hidden when moving the mouse between series. Defaults to true.

Parameters:

stickyTracking - Whether to enable sticky tracking of mouse events.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setThreshold

public T setThreshold(Number threshold)

Convenience method for setting the "threshold" option for the plot options. Equivalent to:

     plotOptions.setOptions("threshold", 0);
 

The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor. Defaults to 0

Parameters:

threshold - A minimum z-value determine whether bubbles will be displayed if 'displayNegative' is false.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

Since:

1.6.0

setTurboThreshold

public T setTurboThreshold(Number turboThreshold)

Convenience method for setting the "turboThreshold" optioin for the plot options. Equivalent to:

     plotOptions.setOptions("turboThreshold", 1000);
 

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. Defaults to 1000

Parameters:

turboThreshold - The maximum size of an array to be greater than two-dimensional and check the format of each entry.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

Since:

1.6.0

setVisible

public T setVisible(boolean visible)

Convenience method for setting the 'visible' plot option. Equivalent to:

     plotOptions.setOption("visible", false);
 

Set the initial visibility of the series. Defaults to true.

Parameters:

visible - The initial visibility of the series.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setZIndex

public T setZIndex(Number zIndex)

Convenience method for setting the 'zIndex' plot option. Equivalent to:

     plotOptions.setOption("visible", false);
 

Define the z index of the series. Defaults to null.

Parameters:

zIndex - The z index of the series.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setZoneAxis

public T setZoneAxis(Zone.Axis zoneAxis)

Convenience method for setting the 'zoneAxis' plot option. Equivalent to:

     plotOption.setOption("zoneAxis", "y");
 

Defines the Axis on which the zones are applied. Defaults to y.

Parameters:

zoneAxis -

Returns:

A reference to this PlotOptions instance for convenient method chaining.

See Also:

Zone.Axis

setZones

public T setZones(Zone... zones)

Convenience method for setting the 'zone' plot option. Equivalent to:

     plotOption.setOption("zone", );
 

Parameters:

zones - An array defining zones within a series.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

See Also:

Zone