org.moxieapps.gwt.highcharts.client.plotOptions

Class SplinePlotOptions

java.lang.Object

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

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

org.moxieapps.gwt.highcharts.client.plotOptions.SplinePlotOptions

public class SplinePlotOptions
extends PlotOptions<SplinePlotOptions>

Represents the general plot options available for all spline type series, which can be set either generically on the chart via the BaseChart.setSplinePlotOptions(SplinePlotOptions) )} method or directly on a series via the Series.setPlotOptions(PlotOptions) method.

Note that these options are only needed if you want to specifically control the general options for all spline type series in the entire chart. If you instead want to control the options for all series in the chart (not just those of a spline type), then you can use the SeriesPlotOptions class instead. Or, if you want to control the plot options for just one series (and not all spline type series in the chart), use the Series.setPlotOptions(PlotOptions) method.

Since:

1.0.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Nested Class Summary

Nested classes/interfaces inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions

PlotOptions.Cursor, PlotOptions.PointPlacement, PlotOptions.Stacking

Constructor Summary

Constructors

Constructor and Description
SplinePlotOptions()

Method Summary

Methods

Modifier and Type	Method and Description
SplinePlotOptions	setConnectNulls(boolean connectNulls) Convenience method for setting the 'connectNulls' option for the chart.
SplinePlotOptions	setGapSize(Number gapSize) Convenience Method for setting the "gapSize" option of the plot options.

Methods inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions

getDataLabels, setAllowPointSelect, setAnimation, setAnimation, setBaseDataLabels, setColor, setColor, setCropThreshold, setCursor, setDashStyle, setDataGrouping, setDataLabels, setEnableMouseTracking, setHoverStateEnabled, setHoverStateLineWidth, setHoverStateMarker, setId, setLegendIndex, setLineWidth, setLinkedTo, setLinkedTo, setMarker, setNegativeColor, setNegativeColor, setPointInterval, setPointPlacement, setPointStart, setSelected, setShadow, setShowCheckbox, setShowInLegend, setStacking, setStickyTracking, setThreshold, setTurboThreshold, setVisible, setZIndex, setZoneAxis, setZones

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

SplinePlotOptions

public SplinePlotOptions()

Method Detail

setGapSize

public SplinePlotOptions setGapSize(Number gapSize)

Convenience Method for setting the "gapSize" option of the plot options. Equivalent to:

     splinePlotOptions.setOption("gapSize", 5);
 

Defines when to display a gap in the graph. A gap size of 5 means that if the distance between two points is greater than five times that of the two closest points, the graph will be broken.In practice, this option is most often used to visualize gaps in time series. In a stock chart, intraday data is available for daytime hours, while gaps will appear in nights and weekends.. Defaults to 0.

Parameters:

gapSize - The distance between points needed to display a gap in the series.

Returns:

A reference to this SplinePlotOptions instance for convenient method chaining.

Since:

1.6.0

setConnectNulls

public SplinePlotOptions setConnectNulls(boolean connectNulls)

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

     splinePlotOptions.setOption("connectNulls", true);
 

Whether to draw a line between points on either side of a null point, or render a gap between them.

Parameters:

connectNulls - 'true' to connect points on either side of a null point

Returns:

A reference to this SplinePlotOptions instance for convenient method chaining.

Since:

1.6.0