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

java.lang.Object
  org.moxieapps.gwt.highcharts.client.Configurable<T>
      org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions<T>
          org.moxieapps.gwt.highcharts.client.plotOptions.BaseMapOptions<TreemapPlotOptions>
              org.moxieapps.gwt.highcharts.client.plotOptions.TreemapPlotOptions

public class TreemapPlotOptions
extends BaseMapOptions<TreemapPlotOptions>

Represents the general plot options available for all treemap type series, which can be set either generically on the chart via the BaseChart.setTreemapPlotOptions(TreemapPlotOptions) method or directly on a series via the Series.setPlotOptions(PlotOptions) method.

Note that these options are only needed if you want to specifically control the general options for all treemap type series in the entire chart. If you instead want to control the options for all series in the chart (not just those of a treemap type), then you can use the SeriesPlotOptions class instead. Or, if you want to control the plot options for just one series (and not all treemap type series in the chart), use the Series.setPlotOptions(PlotOptions) method.

Since:

1.7.0

Author:

cskowron@moxiegroup.com (Cory Skowronek)

Nested Class Summary

static class	TreemapPlotOptions.LayoutAlgorithm An enum representing the available layout algorithms
static class	TreemapPlotOptions.LayoutStartingDirection A Enum representing the available directions that the layout algorithm will start drawing
static class	TreemapPlotOptions.Level Configurable inner class used to set options on specific levels.

Nested classes/interfaces inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions

PlotOptions.Cursor, PlotOptions.PointPlacement, PlotOptions.Stacking

Constructor Summary

TreemapPlotOptions()

Method Summary

TreemapPlotOptions	setAllowDrillToNode(boolean allowDrillToNode) Convenience method for setting the 'allowDrillToNode' option of the treemap.
TreemapPlotOptions	setAlternateStartingDirection(boolean alternateStartingDirection) Convenience method for setting the 'alternateStartingDirection' option of the treemap.
TreemapPlotOptions	setInteractByLeaf(boolean interactByLeaf) Convenience method for setting the 'interactByLeaf' option of the treemap.
TreemapPlotOptions	setLayoutAlgorithm(TreemapPlotOptions.LayoutAlgorithm layoutAlgorithm) Convenience method for setting the 'layoutAlgorithm' option of the treemap.
TreemapPlotOptions	setLayoutStartingDirection(TreemapPlotOptions.LayoutStartingDirection layoutStartingDirection) Convenience method for setting the 'layoutStartingDirection' option of the treemap.
TreemapPlotOptions	setLevelIsConstant(boolean levelIsConstant) Convenience method for setting the 'levelIsConstant' option of the treemap.
TreemapPlotOptions	setLevels(TreemapPlotOptions.Level... levels) Convenience method for setting the 'levels' option of the treemap.

Methods inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.BaseMapOptions

setBorderColor, setBorderWidth, setHoverStateBorderColor, setHoverStateBorderWidth, setHoverStateBrightness, setHoverStateColor, setHoverStateEnabled, setNormalStateAnimation, setNormalStateAnimation, setSelectStateBorderColor, setSelectStateBorderWidth, setSelectStateColor, setSelectStateEnabled

Methods inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions

getDataLabels, setAllowPointSelect, setAnimation, setAnimation, setBaseDataLabels, setColor, setColor, setCropThreshold, setCursor, setDashStyle, setDataGrouping, setDataLabels, setEnableMouseTracking, setHoverStateLineWidth, setHoverStateMarker, setId, setLegendIndex, setLineWidth, setLinkedTo, setLinkedTo, setMarker, setNegativeColor, setNegativeColor, setPointInterval, setPointPlacement, setPointStart, setSelected, setShadow, setShowCheckbox, setShowInLegend, setStacking, setStickyTracking, setThreshold, setTurboThreshold, setVisible, setZIndex, setZoneAxis, setZones

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

public TreemapPlotOptions()

Method Detail

setAllowDrillToNode

public TreemapPlotOptions setAllowDrillToNode(boolean allowDrillToNode)

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

     treeMapPlotOptions.setOption("allowDrillToNode", true);
 

Parameters:

allowDrillToNode - When true the user can click on a point which is a parent and zoom in on its children. Defaults to false.

Returns:

A reference to this TreemapPlotOptions for convenient method chaining.

setAlternateStartingDirection

public TreemapPlotOptions setAlternateStartingDirection(boolean alternateStartingDirection)

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

     treeMapPlotOptions.setOption("alternateStartingDirection", true);
 

Parameters:

alternateStartingDirection - Allow this series' points to be selected by clicking on the markers, bars or pie slices. Defaults to false.

Returns:

A reference to this TreemapPlotOptions for convenient method chaining.

setInteractByLeaf

public TreemapPlotOptions setInteractByLeaf(boolean interactByLeaf)

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

     treemapPlotOptions.setOption("interactByLeaf", true);
 

This option decides if the user can interact with the parent nodes or just the leaf nodes. When this option is undefined, it will be true by default. However when allowDrillToNode is true, then it will be false by default.

Parameters:

interactByLeaf - 'true' to allow the user to interact with parent nodes.

Returns:

A reference to this TreemapPlotOptions for convenient method chaining.

setLayoutAlgorithm

public TreemapPlotOptions setLayoutAlgorithm(TreemapPlotOptions.LayoutAlgorithm layoutAlgorithm)

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

     treemapPlotOptions.setOption("layoutAlgorithm", "squarified");
 

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 for convenient method chaining.

setLayoutStartingDirection

public TreemapPlotOptions setLayoutStartingDirection(TreemapPlotOptions.LayoutStartingDirection layoutStartingDirection)

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

      treemapPlotOptions.setOption("layoutStartingDirection", "horizontal");
 

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 for convenient method chaining.

setLevelIsConstant

public TreemapPlotOptions setLevelIsConstant(boolean levelIsConstant)

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

     treemapPlotOptions.setOption("levelIsConstant", false);
 

Used together with the levels and allowDrillToNode options. When set to false the first level visible when drilling is considered to be level one. Otherwise the level will be the same as the tree structure. Defaults to true.

Parameters:

levelIsConstant - 'false' to make the first level visible when drilling is considered to be level one.

Returns:

A reference to this TreemapPlotOptions for convenient method chaining.

setLevels

public TreemapPlotOptions setLevels(TreemapPlotOptions.Level... levels)

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

     treemapPlotOptions.setOption("levels", new Level());
 

Set options on specific levels. Takes precedence over series options, but not point options.

Parameters:

levels - An object of the TreemapPlotOptions.Level class containing configuration options for the series on each particular level

Returns:

A reference to this TreemapPlotOptions for convenient method chaining.