org.moxieapps.gwt.highcharts.client.plotOptions

Class Dial

java.lang.Object

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

org.moxieapps.gwt.highcharts.client.plotOptions.BaseGaugePart<Dial>

org.moxieapps.gwt.highcharts.client.plotOptions.Dial

public class Dial
extends BaseGaugePart<Dial>

Represents the general dial options available for for the gauge's dial, 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.

Sample usage:

     Chart.setGaugePlotOptions(
          new GaugePlotOptions()
              .setDialOptions(
                  new Dial()
                      .setBaseLength("75%")
              )
     );
 

Since:

1.6.0

Author:

cskoworn@moxiegroup.com (Cory Skowronek)

Constructor Summary

Constructors

Constructor and Description
Dial()

Method Summary

Methods

Modifier and Type	Method and Description
Dial	setBaseLength(String baseLength) Convenience method for setting the "baseLength" option for a gauge's dial.
Dial	setBaseWidth(Number baseWidth) Convenience method for setting the "baseWidth" option for a gauge's dial.
Dial	setRearLength(String rearLength) Convenience method for setting the "rearLength" option for a gauge's dial.
Dial	setTopWidth(Number topWidth) Convenience method for setting the "topLength" option for a gauge's dial.

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

setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setBorderWidth, setRadius

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

Dial

public Dial()

Method Detail

setBaseLength

public Dial setBaseLength(String baseLength)

Convenience method for setting the "baseLength" option for a gauge's dial. Equivalent to:

     dial.setOption("baseLength", "75%");
 

The length of the dial's base part, relative to the total radius or length of the dial. Defaults to 70%.

Parameters:

baseLength - The length of the base of the dial as a percentage of its radius.

Returns:

A reference to this Dial for convenient method chaining.

setBaseWidth

public Dial setBaseWidth(Number baseWidth)

Convenience method for setting the "baseWidth" option for a gauge's dial. Equivalent to:

     dial.setOption("baseWidth", 5)
 

The pixel width of the base of the gauge dial. The base is the part closest to the pivot, defined by baseLength. Defaults to 3.

Parameters:

baseWidth - The width, in pixels, of the dial.

Returns:

A reference to this Dial for convenient method chaining.

setRearLength

public Dial setRearLength(String rearLength)

Convenience method for setting the "rearLength" option for a gauge's dial. Equivalent to:

     dial.setOption("rearLength", "15%");
 

The length of the dial's rear end, the part that extends out on the other side of the pivot. Relative to the dial's length. Defaults to 10%.

Parameters:

rearLength - The length of the rear end of the dial as a percentage of the radius.

Returns:

A reference to this Dial for convenient method chaining.

setTopWidth

public Dial setTopWidth(Number topWidth)

Convenience method for setting the "topLength" option for a gauge's dial. Equivalent to:

     dial.setOption("topLength", 2);
 

The width of the top of the dial, closest to the perimeter. The pivot narrows in from the base to the top. Defaults to 1.

Parameters:

topWidth - The width, in pixels, of the tip of the dial.

Returns:

A reference to this Dial for convenient method chaining.