org.moxieapps.gwt.highcharts.client.plotOptions

Class BaseGaugePlotOptions<T extends BaseGaugePlotOptions>

java.lang.Object

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

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

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

Direct Known Subclasses:

GaugePlotOptions, SolidGaugePlotOptions

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

A common base class for GaugePlotOptions and SolidGaugePlotOptions to prevent code duplication while still maintaining a cleaner way for the user to utilize the method chaining with the generics in place. You should not use this class directly, but instead us one of the base classes.

Since:

1.7.0

Author:

cskowron@moxiegroup.com (Cory Skowronek)

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
BaseGaugePlotOptions()

Method Summary

Methods

Modifier and Type	Method and Description
T	setOvershoot(Number overshoot) Convenience method for setting the "overshoot" option for gauge charts.
T	setWrap(Boolean wrap) Convenience method for setting the "wrap" option for gauge charts.

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

BaseGaugePlotOptions

public BaseGaugePlotOptions()

Method Detail

setOvershoot

public T setOvershoot(Number overshoot)

Convenience method for setting the "overshoot" option for gauge charts. Equivalent to:

     gaugePlotOptions.setOption("overshoot,
 

Parameters:

overshoot -

Returns:

setWrap

public T setWrap(Boolean wrap)

Convenience method for setting the "wrap" option for gauge charts. Equivalent to:

     gaugePlotOptions.setOption("wrap", false)
 

When this option is true, the dial will wrap around the axes. For instance, in a full-range gauge going from 0 to 360, a value of 400 will point to 40. When wrap is false, the dial stops at 360. Defaults to true

Parameters:

wrap - Whether the dial will wrap around its maximum value.

Returns:

A reference to this GaugePlotOptions for convenient method chaining.