org.moxieapps.gwt.highcharts.client

Class Options3D

java.lang.Object

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

org.moxieapps.gwt.highcharts.client.Options3D

public class Options3D
extends Configurable<Options3D>

The Options3d class represents a set of options for a 3D chart. This class should only be instantiated as part of a call to Chart.setOptions3D(Options3D) Example usage:

     chart.setOptions3d(
          new Options3d()
              .setAlpha(50);
 

Options to render charts in 3 dimensions. Note that this feature requires highcharts-3d.js

Since:

1.7.0

Author:

cskowron@moxiegroup.com (Cory Skowronek)

Constructor Summary

Constructors

Constructor and Description
Options3D()

Method Summary

Methods

Modifier and Type	Method and Description
Options3D	setAlpha(Number alpha) Convenience method for setting the 'alpha' attribute of a 3d chart.
Options3D	setBeta(Number beta) Convenience method for setting the 'bets' attribute of a 3d chart.
Options3D	setDepth(Number depth) Convenience method for setting the 'depth' attribute of a 3d chart.
Options3D	setEnabled(Boolean enabled) Convenience method for setting the 'enabled' attribute of a 3d chart.
Options3D	setFrame(Frame frame) Convenience method for setting the 'frame' attribute of a 3d chart.
Options3D	setViewDistance(Number viewDistance) Convenience method for setting the 'viewDistance' option of a 3d chart.

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

Options3D

public Options3D()

Method Detail

setAlpha

public Options3D setAlpha(Number alpha)

Convenience method for setting the 'alpha' attribute of a 3d chart. Equivalent to:

      options3d.setOption("alpha", 0);
 

Parameters:

alpha - One of the two rotation angles for the chart. Defaults to 0.

Returns:

A reference to this Options3D instance for convenient method chaining.

setBeta

public Options3D setBeta(Number beta)

Convenience method for setting the 'bets' attribute of a 3d chart. Equivalent to:

     options3d.setOption("beta", 0);
 

Parameters:

beta - One of the two rotation angles for the chart. Defaults to 0.

Returns:

A reference to this Options3D instance for convenient method chaining.

setDepth

public Options3D setDepth(Number depth)

Convenience method for setting the 'depth' attribute of a 3d chart. Equivalent to:

      options3d.setOption("depth", 100);
 

Parameters:

depth - The total depth of the chart. Defaults to 100.

Returns:

A reference to this Options3D instance for convenient method chaining.

setEnabled

public Options3D setEnabled(Boolean enabled)

Convenience method for setting the 'enabled' attribute of a 3d chart. Equivalent to:

      options3d.setOption("enabled", false);
 

Parameters:

enabled - Whether to render the chart using the 3D functionality. Defaults to false.

Returns:

A reference to this Options3D instance for convenient method chaining.

setFrame

public Options3D setFrame(Frame frame)

Convenience method for setting the 'frame' attribute of a 3d chart. Note that this method makes use of the Frame as well as its inner Frame.FramePanel class. Equivalent to:

      options3d.setOption("frame", new Frame());
 

Parameters:

frame - An instance of the Frame class. Provides the option to draw a frame around the charts by defining a bottom, front and back panel.

Returns:

A reference to this Options3D instance for convenient method chaining.

See Also:

Frame, Frame.FramePanel

setViewDistance

public Options3D setViewDistance(Number viewDistance)

Convenience method for setting the 'viewDistance' option of a 3d chart. Eqiuvalent to:

      options3d.setOption("viewDistance", 30);
 

Parameters:

viewDistance - Defines the distance the viewer is standing in front of the chart, this setting is important to calculate the perspective effect in column and scatter charts. It is not used for 3D pie charts. Defaults to 100.

Returns:

A reference to this Options3D instance for convenient method chaining.