org.fujion.highcharts

Class PlotTreeMap

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.PlotOptions

org.fujion.highcharts.PlotTreeMap

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class PlotTreeMap
extends PlotOptions

Options for tree map plot.

A tree map displays hierarchical data using nested rectangles. The data can be laid out in varying ways depending on options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlotTreeMap.DrillUpButtonPosition Options for the button appearing when drilling down in a treemap.
static class	PlotTreeMap.LayoutAlgorithm Which algorithm is used for setting position and dimensions of the points.
static class	PlotTreeMap.LayoutStartingDirection Direction the layout algorithm will start drawing.

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	allowDrillToNode When enabled the user can click on a point which is a parent and zoom in on its children.
Boolean	alternateStartingDirection Enabling this option will make the treemap alternate the drawing direction between vertical and horizontal.
String	borderColor The color of the border surrounding each tree map item.
PlotTreeMap.DrillUpButtonPosition	drillUpButton_position Options for the button appearing when drilling down in a treemap.
Boolean	ignoreHiddenPoint Whether to ignore hidden points when the layout algorithm runs.
Boolean	interactByLeaf This option decides if the user can interact with the parent nodes or just the leaf nodes.
PlotTreeMap.LayoutAlgorithm	layoutAlgorithm This option decides which algorithm is used for setting position and dimensions of the points.
PlotTreeMap.LayoutStartingDirection	layoutStartingDirection Defines which direction the layout algorithm will start drawing.
Boolean	levelIsConstant Used together with the levels and allowDrillToNode options.
Double	opacity The opacity of a point in treemap.
Integer	sortIndex The sort index of the point inside the treemap level.

Fields inherited from class org.fujion.highcharts.PlotOptions

allowPointSelect, animation, animationLimit, boostThreshold, className, color, colorByPoint, colorIndex, colors, connectEnds, connectNulls, cropThreshold, cursor, dashStyle, dataLabels, description, enableMouseTracking, exposeElementToA11y, findNearestPointBy, getExtremesFromAll, id, keys, label, linecap, lineWidth, linkedTo, marker, negativeColor, pointInterval, pointIntervalUnit, pointPlacement, pointStart, selected, shadow, showCheckbox, showInLegend, skipKeyboardNavigation, softThreshold, stacking, step, stickyTracking, threshold, tooltip, turboThreshold, type, visible, zoneAxis, zones

Constructor Summary

Constructors

Constructor and Description
PlotTreeMap()

Method Summary

Methods inherited from class org.fujion.highcharts.PlotOptions

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

allowDrillToNode

@Option
public Boolean allowDrillToNode

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

alternateStartingDirection

@Option
public Boolean alternateStartingDirection

Enabling this option will make the treemap alternate the drawing direction between vertical and horizontal. The next levels starting direction will always be the opposite of the previous. Defaults to false.

borderColor

@Option
public String borderColor

The color of the border surrounding each tree map item. Defaults to #e6e6e6.

drillUpButton_position

@Option(value="drillUpButton.position")
public final PlotTreeMap.DrillUpButtonPosition drillUpButton_position

Options for the button appearing when drilling down in a treemap.

ignoreHiddenPoint

@Option
public Boolean ignoreHiddenPoint

Whether to ignore hidden points when the layout algorithm runs. If false, hidden points will leave open spaces. Defaults to true.

interactByLeaf

@Option
public Boolean interactByLeaf

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. Defaults to undefined.

layoutAlgorithm

@Option
public PlotTreeMap.LayoutAlgorithm layoutAlgorithm

This option decides which algorithm is used for setting position and dimensions of the points. Can be one of sliceAndDice, stripes, squarified or strip. Defaults to sliceAndDice.

layoutStartingDirection

@Option
public PlotTreeMap.LayoutStartingDirection layoutStartingDirection

Defines which direction the layout algorithm will start drawing. Defaults to vertical.

levelIsConstant

@Option
public Boolean levelIsConstant

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.

opacity

@Option
public Double opacity

The opacity of a point in treemap. When a point has children, the visibility of the children is determined by the opacity. Defaults to 0.15.

sortIndex

@Option
public Integer sortIndex

The sort index of the point inside the treemap level. Defaults to undefined.

Constructor Detail

PlotTreeMap

public PlotTreeMap()