Class PlotOptionsTreemap
- All Implemented Interfaces:
Serializable
heatmap.js
as well, if
functionality such as the
colorAxis is to be
used.- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds color to the colors arrayvoid
Adds key to the keys arrayvoid
Adds level to the levels arrayvoid
Adds zone to the zones arraygetColor()
Color[]
getCrisp()
String[]
getKeys()
Level[]
Zones[]
getZones()
void
removeColor
(Color color) Removes first occurrence of color in colors arrayvoid
Removes first occurrence of key in keys arrayvoid
removeLevel
(Level level) Removes first occurrence of level in levels arrayvoid
removeZone
(Zones zone) Removes first occurrence of zone in zones arrayvoid
setAllowDrillToNode
(Boolean allowDrillToNode) When enabled the user can click on a point which is a parent and zoom in on its children.void
setAllowPointSelect
(Boolean allowPointSelect) Allow this series' points to be selected by clicking on the markers, bars or pie slices.void
setAlternateStartingDirection
(Boolean alternateStartingDirection) Enabling this option will make the treemap alternate the drawing direction between vertical and horizontal.void
setAnimation
(Boolean animation) Enable or disable the initial animation when a series is displayed.void
setAnimationLimit
(Number animationLimit) For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high.void
setBorderColor
(Color borderColor) The color of the border surrounding each tree map item.void
setBorderWidth
(Number borderWidth) The width of the border surrounding each column or bar.void
setClassName
(String className) A class name to apply to the series' graphical elements.void
The main color of the series.void
setColorByPoint
(Boolean colorByPoint) When using automatic point colors pulled from theoptions.colors
collection, this option determines whether the chart should receive one color per series or one color per point.void
setColorIndex
(Number colorIndex) Styled mode only.void
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.void
When true, each column edge is rounded to its nearest pixel in order to render sharp on screen.void
setCropThreshold
(Number cropThreshold) When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom.void
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.void
setDataLabels
(DataLabels dataLabels) void
setDescription
(String description) Requires Accessibility modulevoid
setEnableMouseTracking
(Boolean enableMouseTracking) Enable or disable the mouse tracking for a specific series.void
setExposeElementToA11y
(Boolean exposeElementToA11y) By default, series are exposed to screen readers as regions.void
setFindNearestPointBy
(Dimension findNearestPointBy) Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.void
setGetExtremesFromAll
(Boolean getExtremesFromAll) Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis.void
setIgnoreHiddenPoint
(Boolean ignoreHiddenPoint) Whether to ignore hidden points when the layout algorithm runs.void
setInteractByLeaf
(Boolean interactByLeaf) This option decides if the user can interact with the parent nodes or just the leaf nodes.void
An array specifying which option maps to which key in the data point array.void
setLayoutAlgorithm
(TreeMapLayoutAlgorithm layoutAlgorithm) This option decides which algorithm is used for setting position and dimensions of the points.void
setLayoutStartingDirection
(TreeMapLayoutStartingDirection layoutStartingDirection) Defines which direction the layout algorithm will start drawing.void
setLevelIsConstant
(Boolean levelIsConstant) Used together with the levels and allowDrillToNode options.void
Set options on specific levels.void
setLinkedTo
(String linkedTo) The id of another series to link to.void
setMaxPointWidth
(Number maxPointWidth) The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.void
setOpacity
(Number opacity) The opacity of a point in treemap.void
setPointDescriptionFormatter
(String _fn_pointDescriptionFormatter) void
setSelected
(Boolean selected) Whether to select the series initially.void
Whether to apply a drop shadow to the graph line.void
setShowCheckbox
(Boolean showCheckbox) If true, a checkbox is displayed next to the legend item to allow selecting the series.void
setShowInLegend
(Boolean showInLegend) Whether to display this series type or specific series item in the legend.void
setSkipKeyboardNavigation
(Boolean skipKeyboardNavigation) If set toTrue
, the accessibility module will skip past the points in this series for keyboard navigation.void
setSortIndex
(Number sortIndex) The sort index of the point inside the treemap level.void
A wrapper object for all the series options in specific states.void
setStickyTracking
(Boolean stickyTracking) Sticky tracking of mouse events.void
setTooltip
(SeriesTooltip tooltip) void
setTurboThreshold
(Number turboThreshold) When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.void
setVisible
(Boolean visible) Set the initial visibility of the series.void
setZoneAxis
(ZoneAxis zoneAxis) Defines the Axis on which the zones are applied.void
An array defining zones within a series.
-
Constructor Details
-
PlotOptionsTreemap
public PlotOptionsTreemap()
-
-
Method Details
-
getChartType
- Overrides:
getChartType
in classAbstractPlotOptions
-
getAllowDrillToNode
- See Also:
-
setAllowDrillToNode
When enabled the user can click on a point which is a parent and zoom in on its children.Defaults to: false
-
getAllowPointSelect
- See Also:
-
setAllowPointSelect
Allow this series' points to be selected by clicking on the markers, bars or pie slices.Defaults to: false
-
getAlternateStartingDirection
- See Also:
-
setAlternateStartingDirection
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
-
getAnimation
- See Also:
-
setAnimation
Enable or disable the initial animation when a series is displayed. Please note that this option only applies to the initial animation of the series itself. For other animations, seeChartModel.setAnimation(Boolean)
-
getAnimationLimit
- See Also:
-
setAnimationLimit
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, setanimationLimit
toInfinity
. -
getBorderColor
- See Also:
-
setBorderColor
The color of the border surrounding each tree map item.Defaults to: #e6e6e6
-
getBorderWidth
- See Also:
-
setBorderWidth
The width of the border surrounding each column or bar.
In styled mode, the stroke width can be set with the
.highcharts-point
rule.Defaults to: 1
-
getClassName
- See Also:
-
setClassName
A class name to apply to the series' graphical elements. -
getColor
- See Also:
-
setColor
The main color of the series. In heat maps this color is rarely used, as we mostly use the color to denote the value of each point. Unless options are set in the colorAxis, the default value is pulled from the options.colors array.Defaults to: null
-
getColorByPoint
- See Also:
-
setColorByPoint
When using automatic point colors pulled from theoptions.colors
collection, this option determines whether the chart should receive one color per series or one color per point.Defaults to: false
-
getColorIndex
- See Also:
-
setColorIndex
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class namehighcharts-color-{n}
. -
getColors
- See Also:
-
setColors
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true. -
addColor
Adds color to the colors array- Parameters:
color
- to add- See Also:
-
removeColor
Removes first occurrence of color in colors array- Parameters:
color
- to remove- See Also:
-
getCrisp
- See Also:
-
setCrisp
When true, each column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, settingcrisp
tofalse
may look better, even though each column is rendered blurry.Defaults to: true
-
getCropThreshold
- See Also:
-
setCropThreshold
When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series.Defaults to: 300
-
getCursor
- See Also:
-
setCursor
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked. -
getDataLabels
- See Also:
-
setDataLabels
-
getDescription
- See Also:
-
setDescription
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
-
getEnableMouseTracking
- See Also:
-
setEnableMouseTracking
Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.Defaults to: true
-
getExposeElementToA11y
- See Also:
-
setExposeElementToA11y
By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.
Requires the Accessibility module.
Defaults to: undefined
-
getFindNearestPointBy
- See Also:
-
setFindNearestPointBy
Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to
'xy'
for scatter series and'x'
for most other series. If the data has duplicate x-values, it is recommended to set this to'xy'
to allow hovering over all points.Applies only to series types using nearest neighbor search (not direct hover) for tooltip.
-
getGetExtremesFromAll
- See Also:
-
setGetExtremesFromAll
Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.Defaults to: false
-
getIgnoreHiddenPoint
- See Also:
-
setIgnoreHiddenPoint
Whether to ignore hidden points when the layout algorithm runs. Iffalse
, hidden points will leave open spaces.Defaults to: true
-
getInteractByLeaf
- See Also:
-
setInteractByLeaf
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. -
getKeys
- See Also:
-
setKeys
An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources. -
addKey
Adds key to the keys array- Parameters:
key
- to add- See Also:
-
removeKey
Removes first occurrence of key in keys array- Parameters:
key
- to remove- See Also:
-
getLayoutAlgorithm
-
setLayoutAlgorithm
This option decides which algorithm is used for setting position and dimensions of the points. Can be one ofsliceAndDice
,stripes
,squarified
orstrip
.Defaults to: sliceAndDice
-
getLayoutStartingDirection
-
setLayoutStartingDirection
Defines which direction the layout algorithm will start drawing. Possible values are "vertical" and "horizontal".Defaults to: vertical
-
getLevelIsConstant
- See Also:
-
setLevelIsConstant
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
-
getLevels
- See Also:
-
setLevels
Set options on specific levels. Takes precedence over series options, but not point options. -
addLevel
Adds level to the levels array- Parameters:
level
- to add- See Also:
-
removeLevel
Removes first occurrence of level in levels array- Parameters:
level
- to remove- See Also:
-
getLinkedTo
- See Also:
-
setLinkedTo
The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series. -
getMaxPointWidth
- See Also:
-
setMaxPointWidth
The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.Defaults to: null
-
getOpacity
- See Also:
-
setOpacity
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
-
getPointDescriptionFormatter
-
setPointDescriptionFormatter
-
getSelected
- See Also:
-
setSelected
Whether to select the series initially. IfshowCheckbox
is true, the checkbox next to the series name will be checked for a selected series.Defaults to: false
-
getShadow
- See Also:
-
setShadow
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containingcolor
,offsetX
,offsetY
,opacity
andwidth
.Defaults to: false
-
getShowCheckbox
- See Also:
-
setShowCheckbox
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by theselected
option.Defaults to: false
-
getShowInLegend
- See Also:
-
setShowInLegend
Whether to display this series type or specific series item in the legend.Defaults to: false
-
getSortIndex
- See Also:
-
setSortIndex
The sort index of the point inside the treemap level. -
getStates
- See Also:
-
setStates
A wrapper object for all the series options in specific states. -
getStickyTracking
- See Also:
-
setStickyTracking
Sticky tracking of mouse events. When true, themouseOut
event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOut
event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. WhenstickyTracking
is false andtooltip.shared
is false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc.Defaults to: true
-
getTooltip
- See Also:
-
setTooltip
-
getTurboThreshold
- See Also:
-
setTurboThreshold
When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to0
disable.Defaults to: 1000
-
getVisible
- See Also:
-
setVisible
Set the initial visibility of the series.Defaults to: true
-
getZoneAxis
- See Also:
-
setZoneAxis
Defines the Axis on which the zones are applied.Defaults to: y
-
getZones
- See Also:
-
setZones
An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the
zoneAxis
option.In styled mode, the color zones are styled with the
.highcharts-zone-{n}
class, or custom classed from theclassName
option (view live demo). -
addZone
Adds zone to the zones array- Parameters:
zone
- to add- See Also:
-
removeZone
Removes first occurrence of zone in zones array- Parameters:
zone
- to remove- See Also:
-