org.moxieapps.gwt.highcharts.client
Class Pane

java.lang.Object
  org.moxieapps.gwt.highcharts.client.Configurable<Pane>
      org.moxieapps.gwt.highcharts.client.Pane

public class Pane
extends Configurable<Pane>

A configurable class that will allow you to control the pane options of the charts, which applies only to polar charts and angular gauges. This configuration object holds general options for the combined X and Y axes set. Each xAxis or yAxis can reference the pane by index. An instance of this class can be constructed and then set on the chart via the Chart.setPane(Pane) method.

Note: many of the pane options are only available if the highcharts-more.js script is included in your GWT module. E.g.:

<script type="text/javascript" src="js/highcharts-more.js"></script>

Since:

1.5.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Constructor Summary

Pane()

Method Summary

Pane	setBackground(PaneBackground... paneBackgrounds) Convenience method for setting the "background" option of the pane.
Pane	setCenter(Number centerX, Number centerY) Convenience method for setting the "center" option of the pane.
Pane	setCenter(String centerX, String centerY) Convenience method for setting the "center" option of the pane.
Pane	setEndAngle(Number endAngle) Convenience method for setting the 'endAngle' option of the pane.
Pane	setSize(Number size) Convenience method for setting the 'size' option of the pane.
Pane	setSize(String size) Convenience method for setting the 'size' option of the pane.
Pane	setStartAngle(Number startAngle) Convenience method for setting the 'startAngle' option of the pane.

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

Pane

public Pane()

Method Detail

setBackground

public Pane setBackground(PaneBackground... paneBackgrounds)

Convenience method for setting the "background" option of the pane. Sample usage:

     chart.setPane(
          newPane()
              .setBackground(
                  new PaneBackground()
                      .setBackgroundColor(#333)
              )
      );
 

Parameters:

paneBackgrounds - An Instance of the PaneBackground class that has been set using its supplied methods.

Returns:

A reference to this Pane instance for convenient method chaining.

setCenter

public Pane setCenter(Number centerX,
                      Number centerY)

Convenience method for setting the "center" option of the pane. Equivalent to:

     pane.setOption("center", [50, 50]);
 

The center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions is given as integers that transform to pixels. Defaults to ['50%', '50%']. Note: This method is for denoting the center of the pane as a pair of (x, y) coordinates. If you instead want to represent the center as a percentage of the plot area size, use this setCenter(String, String).

Parameters:

centerX - The x value of the center of the pane in pixels.

centerY - The y value of the center of the pane in pixels.

Returns:

A reference to this Pane instance for convenient method chaining.

setCenter

public Pane setCenter(String centerX,
                      String centerY)

Convenience method for setting the "center" option of the pane. Equivalent to:

     pane.setOption("center", ['50%', '50%']);
 

The center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions are given as percentages of the plot area size. Defaults to ['50%', '50%']. Note: this method is for denoting the location of the center as a string. If you instead want to represent the center as a pair of (x, y) coordinates, use this setCenter(Number, Number).

Parameters:

centerX - The x coordinate of the center of the pane a percentage of the plot size area.

centerY - The x coordinate of the center of the pane a percentage of the plot size area.

Returns:

A reference to this Pane instance for convenient method chaining.

setStartAngle

public Pane setStartAngle(Number startAngle)

Convenience method for setting the 'startAngle' option of the pane. Equivalent to:

     pane.setOption("startAngle", 90);
 

The start angle of the polar X axis or gauge axis, given in degrees where 0 is north. Defaults to 0.

Parameters:

startAngle - The start angle fo the polar X axis of the chart.

Returns:

A reference to this Pane instance for convenient method chaining.

setEndAngle

public Pane setEndAngle(Number endAngle)

Convenience method for setting the 'endAngle' option of the pane. Equivalent to:

     pane.setOption("endAngle", 180);
 

The end angle of the polar X axis or gauge value axis, given in degrees where 0 is north. Defaults to startAngle + 360.

Parameters:

endAngle - The end angle of the polar X axis or gauge value axis.

Returns:

A reference to this Pane instance for convenient method chaining.

setSize

public Pane setSize(Number size)

Convenience method for setting the 'size' option of the pane. Equivalent to:

     pane.setOption("size", 140);
 

The size of the pane, either as a number defining pixels, or a percentage defining a percentage of the plot are. Defaults to 85%. Note that this method is used for defining the size as a number. For defining the size as a percentage of the plot area use setSize(String)

Parameters:

size - A Number defining the size of the pane in pixels.

Returns:

@return A reference to this Pane instance for convenient method chaining.

Since:

1.7.0

See Also:

setSize(String)

setSize

public Pane setSize(String size)

Convenience method for setting the 'size' option of the pane. Equivalent to:

     pane.setOption("size", "90%");
 

The size of the pane, either as a number defining pixels, or a percentage defining a percentage of the plot are. Defaults to 85%. Note that this method is used for defining the size as a percentage of the plot area. For defining the size as a specific number of pixels use setSize(Number)

Parameters:

size - A String defining the size of the pane in pixels.

Returns:

@return A reference to this Pane instance for convenient method chaining.

Since:

1.7.0

See Also:

setSize(String)