org.moxieapps.gwt.highcharts.client

Class Frame

java.lang.Object

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

org.moxieapps.gwt.highcharts.client.Frame

public class Frame
extends Configurable<Frame>

Provides the option to draw a frame around the chart by defining a bottom, front and back panel. Note that this class should only be instantiated as a parameter of the Options3D.setFrame(Frame) method. Sample usage:

     chart.setOptions3d(
          new Options3d()
              .setFrame(
                  new Frame()
              )
     );
 

Since:

1.7.0

Author:

cskowron@moxiegroup.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Frame.FramePanel Inner class to support setting 'frame' attributes in a 3d chart.

Constructor Summary

Constructors

Constructor and Description
Frame()

Method Summary

Methods

Modifier and Type	Method and Description
Frame	setBack(Frame.FramePanel backFramePanel) Convenience method for setting the 'back' attribute of a 3d chart's frame.
Frame	setBottom(Frame.FramePanel bottomFramePanel) Convenience method for setting the 'bottom' attribute of a 3d chart's frame.
Frame	setSide(Frame.FramePanel sideFramePanel) Convenience method for setting the 'side' attribute of a 3d chart's frame Equivalent to:

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

Frame

public Frame()

Method Detail

setBack

public Frame setBack(Frame.FramePanel backFramePanel)

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

      frame.setOption("back", new FramePanel());
 

Parameters:

backFramePanel - an instance of Frame.FramePanel Defines the back panel of the frame around 3D charts.

Returns:

A reference to this Frame instance for convenient method chaining.

setBottom

public Frame setBottom(Frame.FramePanel bottomFramePanel)

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

      frame.setOption("bottom", new FramePanel());
 

Parameters:

bottomFramePanel - an instance of Frame.FramePanel The bottom of the frame around a 3D chart.

Returns:

A reference to this Frame instance for convenient method chaining.

setSide

public Frame setSide(Frame.FramePanel sideFramePanel)

Convenience method for setting the 'side' attribute of a 3d chart's frame Equivalent to:

      frame.setOption("side", new FramePanel());
 

Parameters:

sideFramePanel - an instance of Frame.FramePanel The side for the frame around a 3D chart.

Returns:

A reference to this Frame instance for convenient method chaining.