com.highsoft.highcharts.common.hichartsclasses

Class HITreegraph

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HISeries

com.highsoft.highcharts.common.hichartsclasses.HITreegraph

public class HITreegraph
extends HISeries

A `treegraph` 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 `treegraph` series are defined in `plotOptions.treegraph`. 3. Options for one single series are given in `the series instance array`. ``` Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, treegraph: { // shared options for all treegraph series } }, series: [{ // specific options for this series instance type: 'treegraph' }] }); ```

Constructor Summary

Constructors

Constructor and Description
HITreegraph()

Method Summary

Modifier and Type	Method and Description
HICollapseButton	getCollapseButton()
java.lang.Boolean	getColorByPoint()
java.util.ArrayList<java.lang.String>	getColors()
java.lang.Boolean	getFillSpace()
java.util.ArrayList	getLevels()
HILink	getLink()
java.lang.Object	getNodeDistance()
java.lang.Object	getNodeWidth()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.Boolean	getReversed()
void	setCollapseButton(HICollapseButton collapseButton) Options applied to collapse Button.
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	setFillSpace(java.lang.Boolean fillSpace) Whether the treegraph series should fill the entire plot area in the X axis direction, even when there are collapsed points.
void	setLevels(java.util.ArrayList levels) /** * description: Set options on specific levels.
void	setLink(HILink link)
void	setNodeDistance(java.lang.Object nodeDistance) The distance between nodes in a tree graph in the longitudinal direction.
void	setNodeWidth(java.lang.Object nodeWidth) The pixel width of each node in a, or the height in case the chart is inverted.
void	setReversed(java.lang.Boolean reversed) Flips the positions of the nodes of a treegraph along the horizontal axis (vertical if chart is inverted).

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

HITreegraph

public HITreegraph()

Method Detail

getCollapseButton

public HICollapseButton getCollapseButton()

getColorByPoint

public java.lang.Boolean getColorByPoint()

getColors

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

getFillSpace

public java.lang.Boolean getFillSpace()

getLevels

public java.util.ArrayList getLevels()

getLink

public HILink getLink()

getNodeDistance

public java.lang.Object getNodeDistance()

getNodeWidth

public java.lang.Object getNodeWidth()

getParams

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

Overrides:

getParams in class HISeries

getReversed

public java.lang.Boolean getReversed()

setCollapseButton

public void setCollapseButton(HICollapseButton collapseButton)

Options applied to collapse Button. The collape button is the small button which indicates, that the node is collapsable.

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.

setFillSpace

public void setFillSpace(java.lang.Boolean fillSpace)

Whether the treegraph series should fill the entire plot area in the X axis direction, even when there are collapsed points.

setLevels

public void setLevels(java.util.ArrayList levels)

/** * description: Set options on specific levels. Takes precedence over series options, but not point options. * demo: * [Treegraph chart with level options applied](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/series-treegraph/level-options)

setLink

public void setLink(HILink link)

setNodeDistance

public void setNodeDistance(java.lang.Object nodeDistance)

The distance between nodes in a tree graph in the longitudinal direction. The longitudinal direction means the direction that the chart flows - in a horizontal chart the distance is horizontal, in an inverted chart (vertical), the distance is vertical. If a number is given, it denotes pixels. If a percentage string is given, the distance is a percentage of the rendered node width. A `nodeDistance` of `100%` will render equal widths for the nodes and the gaps between them. This option applies only when the `nodeWidth` option is `auto`, making the node width respond to the number of columns.

defaults:

 30

setNodeWidth

public void setNodeWidth(java.lang.Object nodeWidth)

The pixel width of each node in a, or the height in case the chart is inverted. For tree graphs, the node width is only applied if the marker symbol is `rect`, otherwise the `marker` sizing options apply. Can be a number or a percentage string, or `auto`. If `auto`, the nodes are sized to fill up the plot area in the longitudinal direction, regardless of the number of levels.

defaults:

 undefined

setReversed

public void setReversed(java.lang.Boolean reversed)

Flips the positions of the nodes of a treegraph along the horizontal axis (vertical if chart is inverted).

defaults:

 false