HighchartsTreegraphSeriesOptions class

A treegraph 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 treegraph series are defined in plotOptions.treegraph.
  3. Options for one single series are given in the series instance array.

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

Inheritance

Constructors

HighchartsTreegraphSeriesOptions.new({HighchartsSeriesAccessibilityOptions? accessibility, bool? allowPointSelect, dynamic animation, double? animationLimit, String? borderColor, double? borderWidth, String? className, bool? clip, HighchartsTreegraphSeriesCollapseButtonOptions? collapseButton, String? color, bool? colorByPoint, double? colorIndex, List? colors, bool? crisp, double? cropThreshold, String? cursor, Map<String, dynamic>? custom, HighchartsTreegraphSeriesDataLabelsOptions? dataLabels, String? description, bool? enableMouseTracking, HighchartsTreegraphSeriesEventsOptions? events, bool? fillSpace, String? id, bool? inactiveOtherPoints, bool? includeInDataExport, double? index, List<String>? keys, HighchartsSeriesLabelOptions? label, double? legendIndex, String? legendSymbol, List<HighchartsTreegraphSeriesLevelsOptions>? levels, HighchartsTreegraphSeriesLinkOptions? link, String? linkedTo, HighchartsTreegraphSeriesMarkerOptions? marker, dynamic nodeDistance, dynamic nodeWidth, bool? nullInteraction, HighchartsSeriesOnPointOptions? onPoint, double? opacity, HighchartsSeriesPointOptions? point, dynamic pointDescriptionFormat, dynamic pointDescriptionFormatter, bool? reversed, bool? selected, bool? showCheckbox, bool? showInLegend, bool? skipKeyboardNavigation, HighchartsSeriesSonificationOptions? sonification, HighchartsTreegraphSeriesStatesOptions? states, bool? stickyTracking, HighchartsTreegraphSeriesTooltipOptions? tooltip, bool? traverseToLeaf, double? turboThreshold, bool? visible, double? zIndex})
A treegraph 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
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
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
borderColor ↔ String?
The color of the border surrounding each tree map item.
getter/setter pair
borderWidth ↔ double?
The width of the border surrounding each tree map item.
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
collapseButton ↔ HighchartsTreegraphSeriesCollapseButtonOptions?
Options applied to collapse Button. The collape button is the small button which indicates, that the node is collapsable.
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
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
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
dataLabels ↔ HighchartsTreegraphSeriesDataLabelsOptions?
Options for the data labels appearing on top of the nodes and links. For treegraph charts, data labels are visible for the nodes by default, but hidden for links. This is controlled by modifying the nodeFormat, and the format that applies to links and is an empty string by default.
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 ↔ HighchartsTreegraphSeriesEventsOptions?
Highcharts Options Widget.
getter/setter pair
fillSpace ↔ bool?
Whether the treegraph series should fill the entire plot area in the X axis direction, even when there are collapsed points.
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
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
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
legendIndex ↔ double?
The sequential index of the series in the legend.
getter/setter pair
legendSymbol ↔ String?
Highcharts Options Widget.
getter/setter pair
levels ↔ List<HighchartsTreegraphSeriesLevelsOptions>?
Highcharts Options Widget.
getter/setter pair
Highcharts Options Widget.
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
marker ↔ HighchartsTreegraphSeriesMarkerOptions?
Highcharts Options Widget.
getter/setter pair
nodeDistance ↔ dynamic
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.
getter/setter pair
nodeWidth ↔ dynamic
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.
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
reversed ↔ bool?
Flips the positions of the nodes of a treegraph along the horizontal axis (vertical if chart is inverted).
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
sonification ↔ HighchartsSeriesSonificationOptions?
Sonification/audio chart options for a series.
getter/setter pair
states ↔ HighchartsTreegraphSeriesStatesOptions?
A wrapper object for all the series options in specific states.
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
tooltip ↔ HighchartsTreegraphSeriesTooltipOptions?
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
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
zIndex ↔ double?
Define the visual z index of the series.
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