HighchartsNetworkgraphSeriesOptions class

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

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

Inheritance

Constructors

HighchartsNetworkgraphSeriesOptions.new({HighchartsSeriesAccessibilityOptions? accessibility, bool? allowPointSelect, String? className, bool? clip, String? color, double? colorIndex, bool? crisp, String? cursor, Map<String, dynamic>? custom, String? dashStyle, HighchartsNetworkgraphSeriesDataLabelsOptions? dataLabels, String? description, bool? draggable, bool? enableMouseTracking, HighchartsNetworkgraphSeriesEventsOptions? events, String? findNearestPointBy, String? id, HighchartsNetworkgraphSeriesInactiveOtherPointsOptions? inactiveOtherPoints, bool? includeInDataExport, double? index, List<String>? keys, HighchartsNetworkgraphSeriesLayoutAlgorithmOptions? layoutAlgorithm, double? legendIndex, String? legendSymbol, String? legendSymbolColor, double? lineWidth, HighchartsNetworkgraphSeriesLinkOptions? link, String? linkedTo, HighchartsNetworkgraphSeriesMarkerOptions? marker, List<HighchartsNetworkgraphSeriesNodesOptions>? nodes, bool? nullInteraction, HighchartsSeriesOnPointOptions? onPoint, double? opacity, HighchartsSeriesPointOptions? point, dynamic pointDescriptionFormat, dynamic pointDescriptionFormatter, bool? relativeXValue, bool? selected, Map<String, dynamic>? shadow, bool? showCheckbox, bool? showInLegend, bool? skipKeyboardNavigation, HighchartsSeriesSonificationOptions? sonification, HighchartsNetworkgraphSeriesStatesOptions? states, bool? stickyTracking, HighchartsSeriesTooltipOptions? tooltip, double? turboThreshold, bool? visible, double? zIndex, List<HighchartsSeriesZonesOptions>? zones})
A networkgraph 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
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
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
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
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 ↔ HighchartsNetworkgraphSeriesDataLabelsOptions?
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
draggable ↔ bool?
Flag to determine if nodes are draggable or not.
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 ↔ HighchartsNetworkgraphSeriesEventsOptions?
Highcharts Options Widget.
getter/setter pair
findNearestPointBy ↔ String?
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.
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 ↔ HighchartsNetworkgraphSeriesInactiveOtherPointsOptions?
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
layoutAlgorithm ↔ HighchartsNetworkgraphSeriesLayoutAlgorithmOptions?
Highcharts Options Widget.
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
legendSymbolColor ↔ String?
Defines the color of the legend symbol for this series. Defaults to undefined, in which case the series color is used. Does not work with styled mode.
getter/setter pair
lineWidth ↔ double?
Pixel width of the graph line.
getter/setter pair
Link style 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
marker ↔ HighchartsNetworkgraphSeriesMarkerOptions?
Highcharts Options Widget.
getter/setter pair
nodes ↔ List<HighchartsNetworkgraphSeriesNodesOptions>?
A collection of options for the individual nodes. The nodes in a networkgraph diagram are auto-generated instances of Highcharts.Point, but options can be applied here and linked by the id.
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?
Opacity of a series parts: line, fill (e.g. area) and dataLabels.
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
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
shadow ↔ Map<String, dynamic>?
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
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 ↔ HighchartsNetworkgraphSeriesStatesOptions?
Highcharts Options Widget.
getter/setter pair
stickyTracking ↔ bool?
Highcharts Options Widget.
getter/setter pair
tooltip ↔ HighchartsSeriesTooltipOptions?
A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
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
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