org.moxieapps.gwt.highcharts.client.plotOptions

Class TreemapPlotOptions.Level

java.lang.Object

org.moxieapps.gwt.highcharts.client.Configurable<TreemapPlotOptions.Level>

org.moxieapps.gwt.highcharts.client.plotOptions.TreemapPlotOptions.Level

Enclosing class:

TreemapPlotOptions

public static class TreemapPlotOptions.Level
extends Configurable<TreemapPlotOptions.Level>

Configurable inner class used to set options on specific levels. These options take precedence over series options, but not point options.

Example usage:

      final TreemapPlotOptions.Level level = new TreemapPlotOptions.Level()
           .setLevel(1)
           .setLayoutAlgorithm(TreemapPlotOptions.LayoutAlgorithm.SLICE_AND_DICE)
      );

      chart.setLevels(level);
 

Constructor Summary

Constructors

Constructor and Description
TreemapPlotOptions.Level()

Method Summary

Methods

Modifier and Type	Method and Description
TreemapPlotOptions.Level	setBorderColor(Color borderColor) Convenience method for setting the 'borderColor' option of the level.
TreemapPlotOptions.Level	setBorderColor(String borderColor) Convenience method for setting the 'borderColor' option of the level.
TreemapPlotOptions.Level	setBorderDashStyle(PlotLine.DashStyle borderDashStyle) Convenience method for setting the 'borderDashStyle' option of the level.
TreemapPlotOptions.Level	setBorderWidth(Number borderWidth) Convenience method for setting the 'borderWidth' option of the level.
TreemapPlotOptions.Level	setColor(Color color) Convenience method for setting the 'color' option of the level.
TreemapPlotOptions.Level	setColor(String color) Convenience method for setting the 'color' option of the level.
TreemapPlotOptions.Level	setDataLabels(DataLabels dataLabels) Convenience method for setting the 'dataLabels' option of the level.
TreemapPlotOptions.Level	setLayoutAlgorithm(TreemapPlotOptions.LayoutAlgorithm layoutAlgorithm) Convenience method for setting the 'layoutAlgorithm' option of the level.
TreemapPlotOptions.Level	setLayoutStartingDirection(TreemapPlotOptions.LayoutStartingDirection layoutStartingDirection) Convenience method for setting the 'layoutStartingDirection' option of the level.
TreemapPlotOptions.Level	setLevel(Number level) Convenience method for setting the 'level' option of the level.

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

TreemapPlotOptions.Level

public TreemapPlotOptions.Level()

Method Detail

setBorderColor

public TreemapPlotOptions.Level setBorderColor(String borderColor)

Convenience method for setting the 'borderColor' option of the level. Equivalent to:

     level.setOption("borderColor", );
 

Can set borderColor on all points which lies on the same level.

Note that this method is intended for setting the color to a simple RBG hex value. If you instead want to set a color to include an alpha channel or a gradient, use the setBorderColor(Color) version instead.

Parameters:

borderColor - The color of the border surrounding each tree map item.

Returns:

A reference to this TreemapPlotOptions.Level instance for convenient method chaining.

setBorderColor

public TreemapPlotOptions.Level setBorderColor(Color borderColor)

Convenience method for setting the 'borderColor' option of the level. Equivalent to:

     level.setOption("borderColor", );
 

Can set borderColor on all points which lies on the same level.

Note that this method is intended for setting the color to a gradient or color that includes an alpha channel. If you instead just want to set the color to a normal RGB hex value you can use the setBorderColor(String) version instead.

Parameters:

borderColor - The color of the border surrounding each tree map item.

Returns:

A reference to this TreemapPlotOptions.Level instance for convenient method chaining.

setBorderDashStyle

public TreemapPlotOptions.Level setBorderDashStyle(PlotLine.DashStyle borderDashStyle)

Convenience method for setting the 'borderDashStyle' option of the level. Equivalent to:

     level.setOption("borderDashStyle", );
 

Set the dash style of the border of all the point which lies on the level. See PlotLine.DashStyle for possible options.

Parameters:

borderDashStyle - The dash style of point borders.

Returns:

A reference to this TreemapPlotOptions.Level instance for convenient method chaining.

setBorderWidth

public TreemapPlotOptions.Level setBorderWidth(Number borderWidth)

Convenience method for setting the 'borderWidth' option of the level. Equivalent to:

     level.setOption("borderWidth", );
 

Can set the borderWidth on all points which lies on the same level.

Parameters:

borderWidth - The width of point borders

Returns:

A reference to this TreemapPlotOptions.Level instance for convenient method chaining.

setColor

public TreemapPlotOptions.Level setColor(Color color)

Convenience method for setting the 'color' option of the level. Equivalent to:

     level.setOption("color", );
 

Can set a color on all points which lies on the same level.

Note that this method is intended for setting the color to a gradient or color that includes an alpha channel. If you instead just want to set the color to a normal RGB hex value you can use the setBorderColor(String) version instead.

Parameters:

color - The color for all points that are on the same level.

Returns:

A reference to this TreemapPlotOptions.Level instance for convenient method chaining.

setColor

public TreemapPlotOptions.Level setColor(String color)

Convenience method for setting the 'color' option of the level. Equivalent to:

     level.setOption("color", );
 

Can set a color on all points which lies on the same level.

Note that this method is intended for setting the color to a simple RBG hex value. If you instead want to set a color to include an alpha channel or a gradient, use the setColor(Color) version instead.

Parameters:

color - The color for all points that are on the same level.

Returns:

A reference to this TreemapPlotOptions.Level instance for convenient method chaining.

setDataLabels

public TreemapPlotOptions.Level setDataLabels(DataLabels dataLabels)

Convenience method for setting the 'dataLabels' option of the level. Equivalent to:

     level.setOption("/dataLabels/enabled", true);
     level.setOption("/dataLabels/align", Labels.Align.CENTER);
     level.setOption("/dataLabels/color", "#CC0000");
 

Defines the appearance of the data labels, static labels for each point.

Sample usage:

 level.setDataLabels(
     new DataLabels()
        .setColor("#FF0000")
 );
 

Parameters:

dataLabels - The configuration of how the data labels should appear.

Returns:

A reference to this TreemapPlotOptions.Level instance for convenient method chaining.

setLayoutAlgorithm

public TreemapPlotOptions.Level setLayoutAlgorithm(TreemapPlotOptions.LayoutAlgorithm layoutAlgorithm)

Convenience method for setting the 'layoutAlgorithm' option of the level. Equivalent to:

     level.setOption("layoutAlgorithm", );
 

This option decides which algorithm is used for setting position and dimensions of the points. See TreemapPlotOptions.LayoutAlgorithm for possible options.

Parameters:

layoutAlgorithm - The algorithm used for setting position and dimension of the points.

Returns:

A reference to this TreemapPlotOptions.Level instance for convenient method chaining.

setLayoutStartingDirection

public TreemapPlotOptions.Level setLayoutStartingDirection(TreemapPlotOptions.LayoutStartingDirection layoutStartingDirection)

Convenience method for setting the 'layoutStartingDirection' option of the level. Equivalent to:

     level.setOption("layoutStartingDirection", );
 

Defines which direction the layout algorithm will start drawing. See TreemapPlotOptions.LayoutStartingDirection for possible options

Parameters:

layoutStartingDirection - The direction in which the layout algorithm will start drawing

Returns:

A reference to this TreemapPlotOptions.Level instance for convenient method chaining.

setLevel

public TreemapPlotOptions.Level setLevel(Number level)

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

     level.setOption("level", 1);
 

Decides which level takes effect from the options set in the levels object.

Parameters:

level - The level for which the particular options will affect

Returns:

A reference to this TreemapPlotOptions.Level instance for convenient method chaining.