org.moxieapps.gwt.highcharts.client.plotOptions
Class GaugePlotOptions

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<GaugePlotOptions>
              org.moxieapps.gwt.highcharts.client.plotOptions.GaugePlotOptions

public class GaugePlotOptions
extends BaseGaugePlotOptions<GaugePlotOptions>

Represents the general plot options available for all gauge type series, which can be set either generically on the chart via the BaseChart.setGaugePlotOptions(GaugePlotOptions) )} 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 gauge 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 gauge 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 gauge type series in the chart), use the Series.setPlotOptions(PlotOptions) method.

Since:

1.6.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

GaugePlotOptions()

Method Summary

GaugePlotOptions	setDialOptions(Dial dial) Convenience method for setting the "dial" option for gauge charts.
GaugePlotOptions	setPivotOptions(Pivot pivot) Convenience method for setting the "pivot" option for gauge charts.
GaugePlotOptions	setWrap(boolean wrap) Convenience method for setting the "wrap" option for gauge charts.

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

setOvershoot, setWrap

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

GaugePlotOptions

public GaugePlotOptions()

Method Detail

setDialOptions

public GaugePlotOptions setDialOptions(Dial dial)

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

     gaugePlotOptions.setOption("wrap", false)
 

     chart.setGaugePlotOptions(new GaugePlotOptions()
          .setPivotOptions(new Dial()
              .setRadius(10)
              .setBorderWidth(1)
           )
     );
 

Parameters:

dial - An instance of the Dial class which can be used to set the various dial options for the gauge.

Returns:

A reference to this GaugePlotOptions for convenient method chaining.

setPivotOptions

public GaugePlotOptions setPivotOptions(Pivot pivot)

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

     gaugePlotOptions.setOption("/pivot/radius", "50%");
 

Sample usage:

     chart.setGaugePlotOptions(new GaugePlotOptions()
          .setDialOptions(new Dial()
              .setRadius("50%")
              .setBaseWidth(10)
           )
     );
 

Parameters:

pivot - An instance of the Pivot class which can be used to set various options pivot options for the gauge.

Returns:

A reference to this GaugePlotOptions for convenient method chaining.

setWrap

public GaugePlotOptions 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.