com.highsoft.highcharts.common.hichartsclasses

Class HITreemap

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HISeries

com.highsoft.highcharts.common.hichartsclasses.HITreemap

public class HITreemap
extends HISeries

A `treemap` series. If the `type` option is not specified, it is inherited from `chart.type`. In TypeScript the `type` option must always be set. Configuration options for the series are given in three levels: 1. Options for all series in a chart are defined in the `plotOptions.series` object. 2. Options for all `treemap` series are defined in `plotOptions.treemap`. 3. Options for one single series are given in `the series instance array`. ``` Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, treemap: { // shared options for all treemap series } }, series: [{ // specific options for this series instance type: 'treemap' }] }); ```

Constructor Summary

Constructors

Constructor and Description
HITreemap()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAllowTraversingTree()
java.lang.Boolean	getAlternateStartingDirection()
java.lang.Number	getBorderRadius()
HIBreadcrumbs	getBreadcrumbs()
java.lang.Boolean	getColorByPoint()
java.util.ArrayList<java.lang.String>	getColors()
java.lang.Boolean	getIgnoreHiddenPoint()
java.lang.Boolean	getInteractByLeaf()
java.lang.String	getLayoutAlgorithm()
java.lang.String	getLayoutStartingDirection()
java.lang.Boolean	getLevelIsConstant()
java.util.ArrayList	getLevels()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.Number	getSortIndex()
void	setAllowTraversingTree(java.lang.Boolean allowTraversingTree) When enabled the user can click on a point which is a parent and zoom in on its children.
void	setAlternateStartingDirection(java.lang.Boolean alternateStartingDirection) Enabling this option will make the treemap alternate the drawing direction between vertical and horizontal.
void	setBorderRadius(java.lang.Number borderRadius) The border radius for each treemap item.
void	setBreadcrumbs(HIBreadcrumbs breadcrumbs) Options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.
void	setColorByPoint(java.lang.Boolean colorByPoint) When using automatic point colors pulled from the `options.colors` collection, this option determines whether the chart should receive one color per series or one color per point.
void	setColors(java.util.ArrayList<java.lang.String> colors) A series specific or series type specific color set to apply instead of the global `colors` when `colorByPoint` is true.
void	setIgnoreHiddenPoint(java.lang.Boolean ignoreHiddenPoint) Whether to ignore hidden points when the layout algorithm runs.
void	setInteractByLeaf(java.lang.Boolean interactByLeaf) This option decides if the user can interact with the parent nodes or just the leaf nodes.
void	setLayoutAlgorithm(java.lang.String layoutAlgorithm) This option decides which algorithm is used for setting position and dimensions of the points.
void	setLayoutStartingDirection(java.lang.String layoutStartingDirection) Defines which direction the layout algorithm will start drawing.
void	setLevelIsConstant(java.lang.Boolean levelIsConstant) Used together with the levels and allowTraversingTree options.
void	setLevels(java.util.ArrayList levels) Set options on specific levels.
void	setSortIndex(java.lang.Number sortIndex) The sort index of the point inside the treemap level.

Methods inherited from class com.highsoft.highcharts.common.hichartsclasses.HISeries

addPoint, addPoint, addPoint, addPoint, animate, drawGraph, drawPoints, getAccessibility, getAllowPointSelect, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getClassName, getClip, getColor, getColorAxis, getColorIndex, getColorKey, getConnectEnds, getConnectNulls, getCrisp, getCropThreshold, getCursor, getCustom, getDashStyle, getData, getDataLabels, getDataSorting, getDefinition, getDescribeSingleSeries, getDescriptionFormat, getDescriptionFormatter, getDragDrop, getEnableMouseTracking, getEvents, getFindNearestPointBy, getGetExtremesFromAll, getId, getInactiveOtherPoints, getIncludeInDataExport, getIndex, getKeys, getLabel, getLegendIndex, getLegendSymbol, getLinecap, getLineWidth, getLinkedTo, getMarker, getName, getNegativeColor, getNullPointValue, getOnPoint, getOpacity, getPoint, getPointAnnotationsDescription, getPointDescriptionEnabledThreshold, getPointDescriptionFormat, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getRelativeXValue, getSelected, getShadow, getShowCheckbox, getShowInLegend, getSkipKeyboardNavigation, getSoftThreshold, getSonification, getStack, getStacking, getStates, getStep, getStickyTracking, getSummary, getThreshold, getTooltip, getTurboThreshold, getType, getVisible, getXAxis, getXAxisDescription, getYAxis, getYAxisDescription, getZIndex, getZoneAxis, getZones, hide, onMouseOut, onMouseOver, remove, remove, remove, remove, removePoint, removePoint, removePoint, render, select, select, setAccessibility, setAllowPointSelect, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setClassName, setClip, setColor, setColorAxis, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setCrisp, setCropThreshold, setCursor, setCustom, setDashStyle, setData, setDataLabels, setDataSorting, setDefinition, setDescribeSingleSeries, setDescriptionFormat, setDescriptionFormatter, setDragDrop, setEnableMouseTracking, setEvents, setFindNearestPointBy, setGetExtremesFromAll, setId, setInactiveOtherPoints, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendIndex, setLegendSymbol, setLinecap, setLineWidth, setLinkedTo, setMarker, setName, setNegativeColor, setNullPointValue, setOnPoint, setOpacity, setOptions, setPoint, setPointAnnotationsDescription, setPointDescriptionEnabledThreshold, setPointDescriptionFormat, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointStart, setProperty, setRelativeXValue, setSelected, setSeriesData, setSeriesData, setSeriesData, setSeriesData, setSeriesVisible, setSeriesVisible, setSeriesVisible, setShadow, setShowCheckbox, setShowInLegend, setSkipKeyboardNavigation, setSoftThreshold, setSonification, setStack, setStacking, setState, setState, setStates, setStep, setStickyTracking, setSummary, setThreshold, setTooltip, setTurboThreshold, setType, setVisible, setXAxis, setXAxisDescription, setYAxis, setYAxisDescription, setZIndex, setZoneAxis, setZones, show, sonify, translate, update, update

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

HITreemap

public HITreemap()

Method Detail

getAllowTraversingTree

public java.lang.Boolean getAllowTraversingTree()

getAlternateStartingDirection

public java.lang.Boolean getAlternateStartingDirection()

getBorderRadius

public java.lang.Number getBorderRadius()

getBreadcrumbs

public HIBreadcrumbs getBreadcrumbs()

getColorByPoint

public java.lang.Boolean getColorByPoint()

getColors

public java.util.ArrayList<java.lang.String> getColors()

getIgnoreHiddenPoint

public java.lang.Boolean getIgnoreHiddenPoint()

getInteractByLeaf

public java.lang.Boolean getInteractByLeaf()

getLayoutAlgorithm

public java.lang.String getLayoutAlgorithm()

getLayoutStartingDirection

public java.lang.String getLayoutStartingDirection()

getLevelIsConstant

public java.lang.Boolean getLevelIsConstant()

getLevels

public java.util.ArrayList getLevels()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Overrides:

getParams in class HISeries

getSortIndex

public java.lang.Number getSortIndex()

setAllowTraversingTree

public void setAllowTraversingTree(java.lang.Boolean allowTraversingTree)

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

setAlternateStartingDirection

public void setAlternateStartingDirection(java.lang.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.

setBorderRadius

public void setBorderRadius(java.lang.Number borderRadius)

The border radius for each treemap item.

setBreadcrumbs

public void setBreadcrumbs(HIBreadcrumbs breadcrumbs)

Options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.

setColorByPoint

public void setColorByPoint(java.lang.Boolean colorByPoint)

When using automatic point colors pulled from the `options.colors` collection, this option determines whether the chart should receive one color per series or one color per point.

setColors

public void setColors(java.util.ArrayList<java.lang.String> colors)

A series specific or series type specific color set to apply instead of the global `colors` when `colorByPoint` is true.

setIgnoreHiddenPoint

public void setIgnoreHiddenPoint(java.lang.Boolean ignoreHiddenPoint)

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

defaults:

 True

setInteractByLeaf

public void setInteractByLeaf(java.lang.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 defaults. However when allowTraversingTree is true, then it will be false by defaults.

setLayoutAlgorithm

public void setLayoutAlgorithm(java.lang.String layoutAlgorithm)

This option decides which algorithm is used for setting position and dimensions of the points.

defaults:

 sliceAndDice

setLayoutStartingDirection

public void setLayoutStartingDirection(java.lang.String layoutStartingDirection)

Defines which direction the layout algorithm will start drawing.

defaults:

 vertical

setLevelIsConstant

public void setLevelIsConstant(java.lang.Boolean levelIsConstant)

Used together with the levels and allowTraversingTree options. When set to false the first level visible to be level one, which is dynamic when traversing the tree. Otherwise the level will be the same as the tree structure.

defaults:

 True

setLevels

public void setLevels(java.util.ArrayList levels)

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

setSortIndex

public void setSortIndex(java.lang.Number sortIndex)

The sort index of the point inside the treemap level.