org.moxieapps.gwt.highcharts.client.plotOptions
Class LinePlotOptions
java.lang.Object
org.moxieapps.gwt.highcharts.client.Configurable<T>
org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions<LinePlotOptions>
org.moxieapps.gwt.highcharts.client.plotOptions.LinePlotOptions
public class LinePlotOptions
- extends PlotOptions<LinePlotOptions>
Represents the general plot options available for all line type series, which can be set either generically
on the chart via the BaseChart.setLinePlotOptions(LinePlotOptions)
)} 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 line 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 line 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 line type
series in the chart), use the Series.setPlotOptions(PlotOptions)
method.
- Since:
- 1.0.0
- Author:
- squinn@moxiegroup.com (Shawn Quinn)
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
LinePlotOptions
public LinePlotOptions()
setCompare
public LinePlotOptions setCompare(LinePlotOptions.Compare compare)
- Convenience method for setting the 'compare' option of the chart. Equivalent to:
linePlotOptions.setOption("compare", "percent");
Compare the values of the series against the first value in the visible range.
The y axis will show percentage or absolute change depending on whether compare is set to
"percent" or "value". When this is applied to multiple series, it allows comparing the development
of the series against each other. Defaults to undefined.
- Parameters:
compare
- The type of comparison between data sets. Can be Compare.PERCENT, or Compare.Value
- Returns:
- A reference to
LinePlotOptions
for convenient method chaining.
setGapSize
public LinePlotOptions setGapSize(Number gapSize)
- Convenience Method for setting the "gapSize" option of the plot options. Equivalent to:
linePlotOptions.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
LinePlotOptions
instance for convenient method chaining. - Since:
- 1.6.0
Copyright © 2015. All Rights Reserved.