HCSeriesTreegraphOptions class

(Highcharts) A treegraph series. If the type option is not specified, it is inherited from chart.type.

Implemented types

Constructors

HCSeriesTreegraphOptions({HCSeriesAccessibilityOptionsObject? accessibility, bool? allowDrillToNode, bool? allowPointSelect, dynamic animation, num? animationLimit, String? boostBlending, num? boostThreshold, String? className, bool? clip, HCPlotTreegraphCollapseButtonOptions? collapseButton, dynamic color, bool? colorByPoint, num? colorIndex, List? colors, bool? crisp, num? cropThreshold, String? cursor, HCDictionary? custom, dynamic dataLabels, HCDataMappingOptionsObject? dataMapping, String? description, bool? enableMouseTracking, HCSeriesEventsOptionsObject? events, bool? fillSpace, String? findNearestPointBy, bool? getExtremesFromAll, num? groupPadding, bool? inactiveOtherPoints, bool? includeInDataExport, List<String>? keys, HCSeriesLabelOptionsObject? label, String? legendSymbol, List<HCPlotTreegraphLevelsOptions>? levels, HCPlotTreegraphLinkOptions? link, String? linkedTo, HCPointMarkerOptionsObject? marker, dynamic nodeDistance, String? nodeSizeBy, dynamic nodeWidth, bool? nullInteraction, dynamic onPoint, num? opacity, HCPlotSeriesPointOptions? point, dynamic pointDescriptionFormat, dynamic pointDescriptionFormatter, num? pointInterval, String? pointIntervalUnit, dynamic pointStart, bool? relativeXValue, bool? reversed, bool? selected, bool? showCheckbox, bool? showInLegend, bool? skipKeyboardNavigation, bool? softThreshold, HCSeriesSonificationOptions? sonification, String? stacking, HCSeriesStatesOptionsObject? states, String? step, bool? stickyTracking, HCSeriesTooltipOptionsObject? tooltip, bool? traverseToLeaf, HCPlotTreegraphTraverseUpButtonOptions? traverseUpButton, num? turboThreshold, bool? visible, bool? zoomEnabled, String? id, num? index, num? legendIndex, dynamic mapData, String? name, dynamic stack, String? type, dynamic xAxis, dynamic yAxis, num? zIndex, dynamic centerInCategory, dynamic curveFactor, List<HCPointOptionsObject>? data, dynamic headers, dynamic layout, dynamic nodePadding})
const

Properties

accessibility → HCSeriesAccessibilityOptionsObject?
(Highcharts) Accessibility options for a series.
final
allowDrillToNode → bool?
(Highcharts) When enabled the user can click on a point which is a parent and zoom in on its children. Deprecated and replaced by allowTraversingTree.
final
allowPointSelect → bool?
(Highcharts) Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
final
animation → dynamic
(Highcharts) 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 und
final
animationLimit → num?
(Highcharts) For some series, there is a limit that shuts down 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 does not run if there is more than 250 points totally. To disable this cap, set `animationLimit
final
boostBlending → String?
(Highcharts) Sets the color blending in the boost module.
final
boostThreshold → num?
(Highcharts) Set the point threshold for when a series should enter boost mode.
final
centerInCategory → dynamic
Not available
final
className → String?
(Highcharts) 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.
final
clip → bool?
(Highcharts) Disable this option to allow series rendering in the whole plotting area.
final
collapseButton → HCPlotTreegraphCollapseButtonOptions?
(Highcharts) Options applied to collapse Button. The collapse button is the small button which indicates, that the node is collapsable.
final
color → dynamic
(Highcharts) 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.
final
colorByPoint → bool?
(Highcharts) 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.
final
colorIndex → num?
(Highcharts) Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
final
colors → List?
(Highcharts) A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
final
crisp → bool?
(Highcharts, Highstock, Gantt) 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, settin
final
cropThreshold → num?
(Highcharts) When the series contains less points than the crop threshold, all points are drawn, even 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 han
final
cursor → String?
(Highcharts) 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.
final
curveFactor → dynamic
Not available
final
custom → HCDictionary?
(Highcharts) 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.
final
data → List<HCPointOptionsObject>?
(Highcharts) An array of data points for the series. For the treegraph series type, points can be given in the following ways:
final
dataLabels → dynamic
(Highcharts, Highstock, Highmaps, Gantt) 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
final
dataMapping → HCDataMappingOptionsObject?
(Highcharts) The mapping between the data table and the series data points. This is used in conjunction with the dataTable option (on chart or series level) to map columns from the data table to the properties of the data points. The keys of the dataMapping object correspond to the properties of
final
description → String?
(Highcharts) Deprecated. Use plotOptions.series.accessibility.description instead.
final
enableMouseTracking → bool?
(Highcharts) 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.
final
events → HCSeriesEventsOptionsObject?
(Highcharts) General event handlers for the series items. These event hooks can also be attached to the series at run time using the Highcharts.addEvent function.
final
fillSpace → bool?
(Highcharts) Whether the treegraph series should fill the entire plot area in the X axis direction, even when there are collapsed points.
final
findNearestPointBy → String?
(Highcharts) 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 allo
final
getExtremesFromAll → bool?
(Highcharts, Highstock, Gantt) 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.
final
groupPadding → num?
(Highcharts) 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.
final
hashCode → int
The hash code for this object.
no setterinherited
headers → dynamic
Not available
final
id → String?
(Highcharts, Highstock, Highmaps, Gantt) An id for the series. This can be used after render time to get a pointer to the series object through chart.get().
final
inactiveOtherPoints → bool?
(Highcharts) Highlight only the hovered point and fade the remaining points.
final
includeInDataExport → bool?
(Highcharts) When set to false will prevent the series data from being included in any form of data export.
final
index → num?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
keys → List<String>?
(Highcharts) 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.
final
label → HCSeriesLabelOptionsObject?
(Highcharts, Highstock, Gantt) 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.
final
layout → dynamic
Not available
final
legendIndex → num?
(Highcharts, Highstock, Highmaps, Gantt) The sequential index of the series in the legend.
final
legendSymbol → String?
(Highcharts) What type of legend symbol to render for this series. Can be one of areaMarker, lineMarker or rectangle.
final
levels → List<HCPlotTreegraphLevelsOptions>?
(Highcharts) Set options on specific levels. Takes precedence over series options, but not point options.
final
final
linkedTo → String?
(Highcharts, Highstock, Gantt) 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.
final
mapData → dynamic
(Highmaps) An array of objects containing a geometry or path definition and optionally additional properties to join in the data as per the joinBy option. GeoJSON and TopoJSON structures can also be passed directly into mapData.
final
marker → HCPointMarkerOptionsObject?
(Highcharts) Options for the point markers of line and scatter-like series. Properties like fillColor, lineColor and lineWidth define the visual appearance of the markers. The symbol option defines the shape. Other series types, like column series, don't have markers, but have visual options
final
name → String?
(Highcharts, Highstock, Highmaps, Gantt) The name of the series as shown in the legend, tooltip etc. If a dataTable and dataMapping are used, the name defaults to the id of the primary data table column. Otherwise, it defaults to "Series {n}", where n is the index of the series, starting at 1.
final
nodeDistance → dynamic
(Highcharts) 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.
final
nodePadding → dynamic
Not available
final
nodeSizeBy → String?
(Highcharts) 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 th
final
nodeWidth → dynamic
(Highcharts) 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.
final
nullInteraction → bool?
(Highcharts, Highstock) 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 `nullFormatter
final
onPoint → dynamic
(Highcharts) Options for the Series on point feature. Only pie and sunburst series are supported at this moment.
final
opacity → num?
(Highcharts) 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.
final
point → HCPlotSeriesPointOptions?
(Highcharts) Properties for each single point.
final
pointDescriptionFormat → dynamic
(Highcharts) Deprecated. Use series.accessibility.point.descriptionFormat instead.
final
pointDescriptionFormatter → dynamic
(Highcharts) Deprecated. Use series.accessibility.point.descriptionFormatter instead.
final
pointInterval → num?
(Highcharts, Highstock, Gantt) 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
final
pointIntervalUnit → String?
(Highcharts, Highstock, Gantt) 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 o
final
pointStart → dynamic
(Highcharts, Highstock, Gantt) 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.
final
relativeXValue → bool?
(Highcharts, Highstock) 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.
final
reversed → bool?
(Highcharts) Flips the positions of the nodes of a treegraph along the horizontal axis (vertical if chart is inverted).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selected → bool?
(Highcharts) 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.
final
showCheckbox → bool?
(Highcharts) 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.
final
showInLegend → bool?
(Highcharts) Whether to display this series type or specific series item in the legend.
final
skipKeyboardNavigation → bool?
(Highcharts) Deprecated. Use series.accessibility.keyboardNavigation instead.
final
softThreshold → bool?
(Highcharts, Highstock) 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.
final
sonification → HCSeriesSonificationOptions?
(Highcharts) Sonification/audio chart options for a series.
final
stack → dynamic
Not available
final
stacking → String?
(Highcharts, Highstock) Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent".
final
states → HCSeriesStatesOptionsObject?
(Highcharts) A wrapper object for all the series options in specific states.
final
step → String?
(Highcharts, Highstock) Whether to apply steps to the line. Possible values are left, center and right.
final
stickyTracking → bool?
(Highcharts, Highstock, Highmaps) 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 serie
final
tooltip → HCSeriesTooltipOptionsObject?
(Highcharts, Highstock, Highmaps) A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip. Overridable properties are headerFormat, pointFormat, yDecimals, xDateFormat, yPrefix and ySuffix. Unlike other series, in a scatter plot the s
final
traverseToLeaf → bool?
(Highcharts) 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.
final
traverseUpButton → HCPlotTreegraphTraverseUpButtonOptions?
(Highcharts) Options for the button appearing when traversing down in a treemap.
final
turboThreshold → num?
(Highcharts, Highstock, Gantt) 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 expen
final
type → String?
(Highcharts, Highstock, Highmaps, Gantt) This property is only in TypeScript non-optional and might be undefined in series objects from unknown sources.
final
visible → bool?
(Highcharts) Set the initial visibility of the series.
final
xAxis → dynamic
Not available
final
yAxis → dynamic
Not available
final
zIndex → num?
(Highcharts, Highstock) Define the visual z index of the series.
final
zoomEnabled → bool?
(Highcharts) Whether to zoom non-cartesian series. If chart.zooming is set, the option allows to disable zooming on an individual non-cartesian series. By default zooming is enabled for all series.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

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