org.moxieapps.gwt.highcharts.client

Class Theme

java.lang.Object

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

org.moxieapps.gwt.highcharts.client.Theme

public class Theme
extends Configurable<Theme>

a configurable class that represents a collection SVG and CSS attributes that are used for changing the look of various chart elements that support the setTheme method (e.g. Drilldown.setDrillUpButtonTheme(Theme), MapNavigation.ButtonOptions.setTheme(Theme).) The object takes SVG attributes like fill, stroke, stroke-width or r, the border radius. The theme also supports style, a collection of CSS properties for the text.

Since:

1.7.0

Author:

cskowron@moxiegroup.com (Cory Skowronek)

Constructor Summary

Constructors

Constructor and Description
Theme()

Method Summary

Methods

Modifier and Type	Method and Description
Theme	setFill(String fill) Convenience method for setting the 'fill' option of the theme.
Theme	setPadding(Number padding) Convenience method for setting the 'padding' option of the theme.
Theme	setR(Number r) Convenience method for setting the 'r' option of the theme.
Theme	setStroke(String stroke) Convenience method for setting the 'stroke' option of the theme.
Theme	setStrokeWidth(Number strokeWidth) Convenience method for setting the 'strokeWidth' option of the theme.
Theme	setStyle(Style style) Convenience method for setting the 'style' option of the theme.

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

Theme

public Theme()

Method Detail

setStrokeWidth

public Theme setStrokeWidth(Number strokeWidth)

Convenience method for setting the 'strokeWidth' option of the theme. Equivalent to:

     theme.setOption("strokeWidth", );
 

The stroke-width property defines the thickness of a line, text or outline of an element.

Parameters:

strokeWidth - The width of the outline on the current object.

Returns:

A reference to this Theme instance for convenient method chaining.

setStroke

public Theme setStroke(String stroke)

Convenience method for setting the 'stroke' option of the theme. Equivalent to:

     theme.setOption("stroke", "#0000FF");
 

The stroke property defines the color of a line, text or outline of an element.

Parameters:

stroke - The color of the outline on the current object.

Returns:

A reference to this Theme instance for convenient method chaining.

setFill

public Theme setFill(String fill)

Convenience method for setting the 'fill' option of the theme. Equivalent to:

     theme.setOption("fill", "#FF0000");
 

The fill property describes the color of the inside of an element.

Parameters:

fill - The color inside the object

Returns:

A reference to this Theme instance for convenient method chaining.

setR

public Theme setR(Number r)

Convenience method for setting the 'r' option of the theme. Equivalent to:

     theme.setOption("r", 10);
 

For a circle, this attribute defines the radius of the element. A value of zero disables rendering of the circle.

Parameters:

r - The radius of the element.

Returns:

A reference to this Theme instance for convenient method chaining.

setPadding

public Theme setPadding(Number padding)

Convenience method for setting the 'padding' option of the theme. Equivalent to:

     theme.setOption("padding", 15);
 

The padding CSS property sets the required padding space on all sides of an element.

Parameters:

padding - The padding space for the element

Returns:

A reference to this Theme instance for convenient method chaining.

setStyle

public Theme setStyle(Style style)

Convenience method for setting the 'style' option of the theme. Equivalent to:

     theme.setOption("style", new Style());
 

Parameters:

style - CSS styles for the axis theme.

Returns:

A reference to this Theme instance for convenient method chaining.