HighchartsTreemapSeriesOptions class

A treemap series. If the type option is not specified, it is inherited from chart.type.

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.

API Docs: https://api.highcharts.com/highcharts/series.treemap

Inheritance

Constructors

HighchartsTreemapSeriesOptions.new({HighchartsSeriesAccessibilityOptions? accessibility, bool? allowDrillToNode, bool? allowPointSelect, bool? allowTraversingTree, bool? alternateStartingDirection, dynamic animation, double? animationLimit, String? boostBlending, double? boostThreshold, String? borderColor, double? borderRadius, double? borderWidth, HighchartsTreemapSeriesBreadcrumbsOptions? breadcrumbs, String? className, bool? clip, HighchartsTreemapSeriesClusterOptions? cluster, String? color, dynamic colorAxis, bool? colorByPoint, double? colorIndex, String? colorKey, List? colors, bool? crisp, double? cropThreshold, String? cursor, Map<String, dynamic>? custom, String? dashStyle, HighchartsTreemapSeriesDataLabelsOptions? dataLabels, String? description, bool? enableMouseTracking, HighchartsTreemapSeriesEventsOptions? events, String? findNearestPointBy, bool? getExtremesFromAll, double? groupPadding, String? id, bool? ignoreHiddenPoint, bool? inactiveOtherPoints, bool? includeInDataExport, double? index, bool? interactByLeaf, List<String>? keys, HighchartsSeriesLabelOptions? label, String? layoutAlgorithm, String? layoutStartingDirection, double? legendIndex, String? legendSymbol, bool? levelIsConstant, List<HighchartsTreemapSeriesLevelsOptions>? levels, double? lineWidth, String? linecap, String? linkedTo, String? negativeColor, String? nodeSizeBy, bool? nullInteraction, HighchartsSeriesOnPointOptions? onPoint, double? opacity, HighchartsSeriesPointOptions? point, dynamic pointDescriptionFormat, dynamic pointDescriptionFormatter, double? pointInterval, String? pointIntervalUnit, dynamic pointStart, bool? relativeXValue, bool? selected, bool? showCheckbox, bool? showInLegend, bool? skipKeyboardNavigation, bool? softThreshold, HighchartsSeriesSonificationOptions? sonification, double? sortIndex, String? stacking, HighchartsTreemapSeriesStatesOptions? states, String? step, bool? stickyTracking, double? threshold, HighchartsTreemapSeriesTooltipOptions? tooltip, bool? traverseToLeaf, HighchartsTreemapSeriesTraverseUpButtonOptions? traverseUpButton, double? turboThreshold, bool? visible, dynamic xAxis, dynamic yAxis, double? zIndex, String? zoneAxis, List<HighchartsSeriesZonesOptions>? zones})
A treemap series. If the type option is not specified, it is inherited from chart.type.

Properties

accessibility ↔ HighchartsSeriesAccessibilityOptions?
Accessibility options for a series.
getter/setter pair
allowDrillToNode ↔ bool?
When enabled the user can click on a point which is a parent and zoom in on its children. Deprecated and replaced by allowTraversingTree.
getter/setter pair
allowPointSelect ↔ bool?
Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
getter/setter pair
allowTraversingTree ↔ bool?
When enabled the user can click on a point which is a parent and zoom in on its children.
getter/setter pair
alternateStartingDirection ↔ bool?
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.
getter/setter pair
animation ↔ dynamic
Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported:
getter/setter pair
animationLimit ↔ double?
Highcharts Options Widget.
getter/setter pair
boostBlending ↔ String?
Sets the color blending in the boost module.
getter/setter pair
boostThreshold ↔ double?
Set the point threshold for when a series should enter boost mode.
getter/setter pair
borderColor ↔ String?
The color of the border surrounding each tree map item.
getter/setter pair
borderRadius ↔ double?
The border radius for each treemap item.
getter/setter pair
borderWidth ↔ double?
The width of the border surrounding each tree map item.
getter/setter pair
Options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.
getter/setter pair
className ↔ String?
An additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element. Changes to the series' color will also be reflected in a chart's legend and tooltip.
getter/setter pair
clip ↔ bool?
Disable this option to allow series rendering in the whole plotting area.
getter/setter pair
cluster ↔ HighchartsTreemapSeriesClusterOptions?
An option to optimize treemap series rendering by grouping smaller leaf nodes below a certain square area threshold in pixels. If the square area of a point becomes smaller than the specified threshold, determined by the pixelWidth and/or pixelHeight options, then this point is moved into one group point per series.
getter/setter pair
color ↔ String?
The main color of the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
getter/setter pair
colorAxis ↔ dynamic
When using dual or multiple color axes, this number defines which colorAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the colorAxis array, with 0 being the first. Set this option to false to prevent a series from connecting to the default color axis.
getter/setter pair
colorByPoint ↔ bool?
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.
getter/setter pair
colorIndex ↔ double?
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
getter/setter pair
colorKey ↔ String?
Highcharts Options Widget.
getter/setter pair
colors ↔ List?
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
getter/setter pair
crisp ↔ bool?
When true, each point or 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, setting crisp to false may look better, even though each column is rendered blurry.
getter/setter pair
cropThreshold ↔ double?
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.
getter/setter pair
cursor ↔ String?
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.
getter/setter pair
custom ↔ Map<String, dynamic>?
A reserved subspace to store options and values for customized functionality. Here you can add additional data for your own event callbacks and formatter callbacks.
getter/setter pair
dashStyle ↔ String?
Name of the dash style to use for the graph, or for some series types the outline of each shape.
getter/setter pair
dataLabels ↔ HighchartsTreemapSeriesDataLabelsOptions?
Highcharts Options Widget.
getter/setter pair
description ↔ String?
A description of the series to add to the screen reader information about the series.
getter/setter pair
enableMouseTracking ↔ bool?
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.
getter/setter pair
events ↔ HighchartsTreemapSeriesEventsOptions?
Highcharts Options Widget.
getter/setter pair
findNearestPointBy ↔ String?
Highcharts Options Widget.
getter/setter pair
getExtremesFromAll ↔ bool?
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.
getter/setter pair
groupPadding ↔ double?
Group padding for parent elements in terms of pixels. See also the nodeSizeBy option that controls how the leaf nodes' size is affected by the padding.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String?
An id for the series. This can be used after render time to get a pointer to the series object through chart.get().
getter/setter pair
ignoreHiddenPoint ↔ bool?
Whether to ignore hidden points when the layout algorithm runs. If false, hidden points will leave open spaces.
getter/setter pair
inactiveOtherPoints ↔ bool?
Highlight only the hovered point and fade the remaining points.
getter/setter pair
includeInDataExport ↔ bool?
When set to false will prevent the series data from being included in any form of data export.
getter/setter pair
index ↔ double?
The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
getter/setter pair
interactByLeaf ↔ bool?
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 allowTraversingTree is true, then it will be false by default.
getter/setter pair
keys ↔ List<String>?
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.
getter/setter pair
label ↔ HighchartsSeriesLabelOptions?
Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position.
getter/setter pair
layoutAlgorithm ↔ String?
This option decides which algorithm is used for setting position and dimensions of the points.
getter/setter pair
layoutStartingDirection ↔ String?
Defines which direction the layout algorithm will start drawing.
getter/setter pair
legendIndex ↔ double?
The sequential index of the series in the legend.
getter/setter pair
legendSymbol ↔ String?
Highcharts Options Widget.
getter/setter pair
levelIsConstant ↔ bool?
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.
getter/setter pair
levels ↔ List<HighchartsTreemapSeriesLevelsOptions>?
Set options on specific levels. Takes precedence over series options, but not point options.
getter/setter pair
linecap ↔ String?
The SVG value used for the stroke-linecap and stroke-linejoin of a line graph. Round means that lines are rounded in the ends and bends.
getter/setter pair
lineWidth ↔ double?
The width of the line connecting the data points.
getter/setter pair
linkedTo ↔ String?
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.
getter/setter pair
negativeColor ↔ String?
The color for the parts of the graph or points that are below the threshold. Note that zones takes precedence over the negative color. Using negativeColor is equivalent to applying a zone with value of 0.
getter/setter pair
nodeSizeBy ↔ String?
Experimental. How to set the size of child nodes when a header or padding is present. When leaf, the group is expanded to make room for headers and padding in order to preserve the relative sizes between leaves. When group, the leaves are naïvely fit into the remaining area after the header and padding are subtracted.
getter/setter pair
nullInteraction ↔ bool?
Whether or not data-points with the value of null should be interactive. When this is set to true, tooltips may highlight these points, and this option also enables keyboard navigation for such points. Format options for such points include nullFormat and nullFormater. Works for these series: line, spline, area, area-spline, column, bar, and* timeline.
getter/setter pair
onPoint ↔ HighchartsSeriesOnPointOptions?
Options for the Series on point feature. Only pie and sunburst series are supported at this moment.
getter/setter pair
opacity ↔ double?
The opacity of grouped points in treemap. When a point has children, the group point is covering the children, and is given this opacity. The visibility of the children is determined by the opacity.
getter/setter pair
point ↔ HighchartsSeriesPointOptions?
Properties for each single point.
getter/setter pair
pointDescriptionFormat ↔ dynamic
Same as accessibility.point.descriptionFormat, but for an individual series. Overrides the chart wide configuration.
getter/setter pair
pointDescriptionFormatter ↔ dynamic
Same as accessibility.series.descriptionFormatter, but for an individual series. Overrides the chart wide configuration.
getter/setter pair
pointInterval ↔ double?
If no x values are given for the points in a series, pointInterval defines the interval of the x values. For example, if a series contains one value every decade starting from year 0, set pointInterval to 10. In true datetime axes, the pointInterval is set in milliseconds.
getter/setter pair
pointIntervalUnit ↔ String?
On datetime series, this allows for setting the pointInterval to irregular time units, day, month and year. A day is usually the same as 24 hours, but pointIntervalUnit also takes the DST crossover into consideration when dealing with local time. Combine this option with pointInterval to draw weeks, quarters, 6 months, 10 years etc.
getter/setter pair
pointStart ↔ dynamic
If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
getter/setter pair
relativeXValue ↔ bool?
When true, X values in the data set are relative to the current pointStart, pointInterval and pointIntervalUnit settings. This allows compression of the data for datasets with irregular X values.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selected ↔ bool?
Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name in the legend will be checked for a selected series.
getter/setter pair
showCheckbox ↔ bool?
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
getter/setter pair
showInLegend ↔ bool?
Whether to display this series type or specific series item in the legend.
getter/setter pair
skipKeyboardNavigation ↔ bool?
If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
getter/setter pair
softThreshold ↔ bool?
When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
getter/setter pair
sonification ↔ HighchartsSeriesSonificationOptions?
Sonification/audio chart options for a series.
getter/setter pair
sortIndex ↔ double?
The sort index of the point inside the treemap level.
getter/setter pair
stacking ↔ String?
Whether to stack the values of each series on top of each other. Possible values are undefined to disable, "normal" to stack by value or "percent".
getter/setter pair
states ↔ HighchartsTreemapSeriesStatesOptions?
A wrapper object for all the series options in specific states.
getter/setter pair
step ↔ String?
Whether to apply steps to the line. Possible values are left, center and right.
getter/setter pair
stickyTracking ↔ bool?
Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series.
getter/setter pair
threshold ↔ double?
The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.
getter/setter pair
tooltip ↔ HighchartsTreemapSeriesTooltipOptions?
Highcharts Options Widget.
getter/setter pair
traverseToLeaf ↔ bool?
This option enables automatic traversing to the last child level upon node interaction. This feature simplifies navigation by immediately focusing on the deepest layer of the data structure without intermediate steps.
getter/setter pair
traverseUpButton ↔ HighchartsTreemapSeriesTraverseUpButtonOptions?
Options for the button appearing when traversing down in a treemap.
getter/setter pair
turboThreshold ↔ double?
When a series contains a data array that is longer than this, the Series class looks for data configurations of plain numbers or arrays of numbers. The first and last valid points are checked. If found, the rest of the data is assumed to be the same. This saves expensive data checking and indexing in long series, and makes data-heavy charts render faster.
getter/setter pair
visible ↔ bool?
Set the initial visibility of the series.
getter/setter pair
xAxis ↔ dynamic
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
getter/setter pair
yAxis ↔ dynamic
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.
getter/setter pair
zIndex ↔ double?
Define the visual z index of the series.
getter/setter pair
zoneAxis ↔ String?
Defines the Axis on which the zones are applied.
getter/setter pair
zones ↔ List<HighchartsSeriesZonesOptions>?
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. The zone definitions have to be in ascending order regarding to the value.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited