HCSeriesSankeyOptions class

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

Implemented types

Constructors

HCSeriesSankeyOptions({HCSeriesAccessibilityOptionsObject? accessibility, bool? allowPointSelect, dynamic animation, dynamic borderColor, num? borderWidth, bool? centerInCategory, String? className, bool? clip, dynamic color, bool? colorByPoint, num? colorIndex, List? colors, String? cursor, num? curveFactor, HCDictionary? custom, String? dashStyle, dynamic dataLabels, HCDataMappingOptionsObject? dataMapping, String? description, bool? enableMouseTracking, HCSeriesEventsOptionsObject? events, bool? getExtremesFromAll, bool? inactiveOtherPoints, bool? includeInDataExport, List<String>? keys, HCSeriesLabelOptionsObject? label, String? legendSymbol, List<HCPlotSankeyLevelsOptions>? levels, String? linkColorMode, String? linkedTo, num? linkOpacity, num? minLinkWidth, String? nodeAlignment, dynamic nodeDistance, num? nodePadding, dynamic nodeWidth, bool? nullInteraction, dynamic onPoint, num? opacity, HCPlotSeriesPointOptions? point, dynamic pointDescriptionFormat, dynamic pointDescriptionFormatter, bool? relativeXValue, bool? selected, bool? showCheckbox, bool? showInLegend, bool? skipKeyboardNavigation, HCSeriesSonificationOptions? sonification, HCSeriesStatesOptionsObject? states, bool? stickyTracking, HCSeriesTooltipOptionsObject? tooltip, 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 borderRadius, dynamic data, dynamic dataParser, dynamic dataURL, dynamic depth, dynamic edgeColor, dynamic edgeWidth, dynamic grouping, dynamic groupPadding, dynamic groupZPadding, dynamic maxPointWidth, List<HCSeriesSankeyNodesOptionsObject>? nodes, dynamic pointPadding, dynamic pointWidth})
const

Properties

accessibility → HCSeriesAccessibilityOptionsObject?
(Highcharts) Accessibility options for a series.
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
borderColor → dynamic
(Highcharts, Highstock, Gantt) The color of the border surrounding each column or bar.
final
borderRadius → dynamic
Not available
final
borderWidth → num?
(Highcharts, Highstock, Gantt) The width of the border surrounding each column or bar. Defaults to 1 when there is room for a border, but to 0 when the columns are so dense that a border would cover the next column.
final
centerInCategory → bool?
(Highcharts, Highstock, Gantt) When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.
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
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, Highstock, Gantt) When using automatic point colors pulled from the global colors or series-specific plotOptions.column.colors collections, 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, Highstock, Gantt) A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
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 → num?
(Highcharts) Higher numbers makes the links in a sankey diagram or dependency wheel render more curved. A curveFactor of 0 makes the lines straight.
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
dashStyle → String?
(Highcharts) Name of the dash style to use for the graph, or for some series types the outline of each shape.
final
data → dynamic
(Highcharts) An array of data points for the series. For the sankey series type, points can be given in the following way:
final
dataLabels → dynamic
(Highcharts, Highstock, Highmaps, Gantt) Options for the data labels appearing on top of the nodes and links. For sankey 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
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
dataParser → dynamic
Not available
final
dataURL → dynamic
Not available
final
depth → dynamic
Not available
final
description → String?
(Highcharts) Deprecated. Use plotOptions.series.accessibility.description instead.
final
edgeColor → dynamic
Not available
final
edgeWidth → dynamic
Not available
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
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
grouping → dynamic
Not available
final
groupPadding → dynamic
Not available
final
groupZPadding → dynamic
Not available
final
hashCode → int
The hash code for this object.
no setterinherited
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
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<HCPlotSankeyLevelsOptions>?
(Highcharts) Set options on specific levels. Takes precedence over series options, but not node and link options.
final
linkColorMode → String?
(Highcharts) Determines color mode for sankey links. Available options:
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
linkOpacity → num?
(Highcharts) Opacity for the links between nodes in the sankey diagram.
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
maxPointWidth → dynamic
Not available
final
minLinkWidth → num?
(Highcharts) The minimal width for a line of a sankey. By default, 0 values are not shown.
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
nodeAlignment → String?
(Highcharts) Determines which side of the chart the nodes are to be aligned to. When the chart is inverted, top aligns to the left and bottom to the right.
final
nodeDistance → dynamic
(Highcharts) 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.
final
nodePadding → num?
(Highcharts) The padding between nodes in a sankey diagram or dependency wheel, in pixels. For sankey charts, this applies to the nodes of the same column, so vertical distance by default, or horizontal distance in an inverted (vertical) sankey.
final
nodes → List<HCSeriesSankeyNodesOptionsObject>?
(Highcharts) A collection of options for the individual nodes. The nodes in a sankey diagram are auto-generated instances of Highcharts.Point, but options can be applied here and linked by the id.
final
nodeWidth → dynamic
(Highcharts) The pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted.
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) Opacity for the nodes in the sankey diagram.
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
pointPadding → dynamic
Not available
final
pointWidth → dynamic
Not available
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
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 particular series or series type in the legend. Standalone series are shown in legend by default, and linked series are not. Since v7.2.0 it is possible to show series that use colorAxis by setting this option to true.
final
skipKeyboardNavigation → bool?
(Highcharts) Deprecated. Use series.accessibility.keyboardNavigation instead.
final
sonification → HCSeriesSonificationOptions?
(Highcharts) Sonification/audio chart options for a series.
final
stack → dynamic
(Highcharts, Highstock) This option allows grouping series in a stacked chart. The stack option can be a string or anything else, as long as the grouped series' stack options match each other after conversion into a string.
final
states → HCSeriesStatesOptionsObject?
(Highcharts) A collection of options for different series states.
final
stickyTracking → bool?
(Highcharts) 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.
final
tooltip → HCSeriesTooltipOptionsObject?
(Highcharts) 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.
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
(Highcharts, Highstock) 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.
final
yAxis → dynamic
(Highcharts, Highstock) 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.
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