HighchartsArcDiagramSeriesOptions class

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

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

Inheritance

Constructors

HighchartsArcDiagramSeriesOptions.new({HighchartsSeriesAccessibilityOptions? accessibility, bool? allowPointSelect, dynamic animation, String? borderColor, double? borderWidth, bool? centeredLinks, String? className, bool? clip, String? color, bool? colorByPoint, double? colorIndex, List? colors, String? cursor, Map<String, dynamic>? custom, String? dashStyle, HighchartsArcDiagramSeriesDataGroupingOptions? dataGrouping, HighchartsArcDiagramSeriesDataLabelsOptions? dataLabels, String? description, bool? enableMouseTracking, bool? equalNodes, HighchartsSeriesEventsOptions? events, String? id, HighchartsArcDiagramSeriesInactiveOtherPointsOptions? inactiveOtherPoints, bool? includeInDataExport, double? index, List<String>? keys, HighchartsSeriesLabelOptions? label, double? legendIndex, String? legendSymbol, List<HighchartsArcDiagramSeriesLevelsOptions>? levels, String? linkColorMode, double? linkOpacity, double? linkRadius, double? linkWeight, String? linkedTo, HighchartsArcDiagramSeriesMarkerOptions? marker, double? minLinkWidth, dynamic nodeDistance, dynamic nodeWidth, List<HighchartsArcDiagramSeriesNodesOptions>? nodes, bool? nullInteraction, String? offset, HighchartsSeriesOnPointOptions? onPoint, double? opacity, HighchartsSeriesPointOptions? point, dynamic pointDescriptionFormat, dynamic pointDescriptionFormatter, bool? reversed, bool? selected, bool? showCheckbox, bool? showInLegend, bool? skipKeyboardNavigation, HighchartsSeriesSonificationOptions? sonification, HighchartsArcDiagramSeriesStatesOptions? states, bool? stickyTracking, HighchartsArcDiagramSeriesTooltipOptions? tooltip, double? turboThreshold, bool? visible, double? zIndex})
An arcdiagram 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
borderColor ↔ String?
The color of the border surrounding each column or bar.
getter/setter pair
borderWidth ↔ double?
Highcharts Options Widget.
getter/setter pair
The option to center links rather than position them one after another
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
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?
Highcharts Options Widget.
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
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
dataGrouping ↔ HighchartsArcDiagramSeriesDataGroupingOptions?
Highcharts Options Widget.
getter/setter pair
dataLabels ↔ HighchartsArcDiagramSeriesDataLabelsOptions?
Options for the data labels appearing on top of the nodes and links. For arc diagram 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
equalNodes ↔ bool?
Whether nodes with different values should have the same size. If set to true, all nodes are calculated based on the nodePadding and current plotArea. It is possible to override it using the marker.radius option.
getter/setter pair
events ↔ HighchartsSeriesEventsOptions?
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.
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 ↔ HighchartsArcDiagramSeriesInactiveOtherPointsOptions?
Highcharts Options Widget.
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?
What type of legend symbol to render for this series. Can be one of areaMarker, lineMarker or rectangle.
getter/setter pair
levels ↔ List<HighchartsArcDiagramSeriesLevelsOptions>?
Set options on specific levels. Takes precedence over series options, but not node and link options.
getter/setter pair
linkColorMode ↔ String?
Determines color mode for sankey links. Available options:
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
linkOpacity ↔ double?
Opacity for the links between nodes in the sankey diagram.
getter/setter pair
linkRadius ↔ double?
The radius of the link arc. If not set, series renders a semi-circle between the nodes, except when overflowing the edge of the plot area, in which case an arc touching the edge is rendered. If linkRadius is set, an arc extending to the given value is rendered.
getter/setter pair
linkWeight ↔ double?
The global link weight, in pixels. If not set, width is calculated per link, depending on the weight value.
getter/setter pair
marker ↔ HighchartsArcDiagramSeriesMarkerOptions?
Highcharts Options Widget.
getter/setter pair
minLinkWidth ↔ double?
The minimal width for a line of a sankey. By default, 0 values are not shown.
getter/setter pair
nodeDistance ↔ dynamic
The distance between nodes in a sankey diagram 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
nodes ↔ List<HighchartsArcDiagramSeriesNodesOptions>?
A collection of options for the individual nodes. The nodes in an arc diagram are auto-generated instances of Highcharts.Point, but options can be applied here and linked by the id.
getter/setter pair
nodeWidth ↔ dynamic
The pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted.
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
offset ↔ String?
The offset of an arc diagram nodes column in relation to the plotArea. The offset equal to 50% places nodes in the center of a chart. By default the series is placed so that the biggest node is touching the bottom border of the plotArea.
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?
Opacity for the nodes in the sankey diagram.
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?
Whether the series should be placed on the other side of the plotArea.
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?
Highcharts Options Widget.
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 ↔ HighchartsArcDiagramSeriesStatesOptions?
Highcharts Options Widget.
getter/setter pair
stickyTracking ↔ bool?
Highcharts Options Widget.
getter/setter pair
tooltip ↔ HighchartsArcDiagramSeriesTooltipOptions?
Highcharts Options Widget.
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