HighchartsFlowMapSeriesOptions class
A flowmap
series. If the type option
is not specified, it is inherited from chart.type.
Configuration options for the series are given in three levels:
- Options for all series in a chart are defined in the plotOptions.series object.
- Options for all
flowmap
series are defined in plotOptions.flowmap. - Options for one single series are given in the series instance array.
API Docs: https://api.highcharts.com/highmaps/series.flowmap
- Inheritance
-
- Object
- HighchartsOptionsBase
- HighchartsFlowMapSeriesOptions
Constructors
- HighchartsFlowMapSeriesOptions.new({bool? animation, bool? colorByPoint, String? colorKey, List? colors, double? curveFactor, String? fillColor, double? fillOpacity, String? id, double? index, double? legendIndex, String? legendSymbol, double? lineWidth, String? linecap, String? linkedTo, HighchartsFlowMapSeriesMarkerEndOptions? markerEnd, double? maxWidth, double? minWidth, String? nullColor, bool? nullInteraction, dynamic opacity, HighchartsFlowMapSeriesStatesOptions? states, HighchartsFlowMapSeriesTooltipOptions? tooltip, double? weight, double? width, bool? zoomEnabled})
-
A
flowmap
series. If the type option is not specified, it is inherited from chart.type.
Properties
- animation ↔ bool?
-
Highcharts Options Widget.
getter/setter pair
- colorByPoint ↔ bool?
-
When using automatic point colors pulled from the global
colors or series-specific
plotOptions.map.colors collections, this option
determines whether the chart should receive one color per series or
one color per point.
getter/setter pair
- colorKey ↔ String?
-
Highcharts Options Widget.
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
- curveFactor ↔ double?
-
The
curveFactor
option for all links. Value higher than 0 will curve the link clockwise. A negative value will curve it counter clockwise. If the value is 0 the link will be a straight line. By default undefined curveFactor get an automatic curve.getter/setter pair - fillColor ↔ String?
-
The fill color of all the links. If not set, the series color will be
used with the opacity set in
fillOpacity.
getter/setter pair
- fillOpacity ↔ double?
-
The opacity of the color fill for all links.
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 - 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 - legendIndex ↔ double?
-
The sequential index of the series in the legend.
getter/setter pair
- legendSymbol ↔ String?
-
Highcharts Options Widget.
getter/setter pair
- linecap ↔ String?
-
The SVG value used for the
stroke-linecap
andstroke-linejoin
of the map borders. Round means that borders are rounded in the ends and bends.getter/setter pair - lineWidth ↔ double?
-
Specify the
lineWidth
of the links if they are not specified.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, which is
necessary for operations such as zoom or updates on the flowmap
series.
getter/setter pair
- markerEnd ↔ HighchartsFlowMapSeriesMarkerEndOptions?
-
A
markerEnd
creates an arrow symbol indicating the direction of flow at the destination. Specifying amarkerEnd
here will create one for each link.getter/setter pair - maxWidth ↔ double?
-
Maximum width of a link expressed in pixels. The weight of a link is
mapped between
maxWidth
andminWidth
.getter/setter pair - minWidth ↔ double?
-
Minimum width of a link expressed in pixels. The weight of a link is
mapped between
maxWidth
andminWidth
.getter/setter pair - nullColor ↔ String?
-
The color to apply to null points.
getter/setter pair
- nullInteraction ↔ bool?
-
Whether to allow pointer interaction like tooltips and mouse events
on null points.
getter/setter pair
- opacity ↔ dynamic
-
The opacity of all the links. Affects the opacity for the entire
link, including stroke. See also
fillOpacity, that affects the
opacity of only the fill color.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- states ↔ HighchartsFlowMapSeriesStatesOptions?
-
Highcharts Options Widget.
getter/setter pair
- tooltip ↔ HighchartsFlowMapSeriesTooltipOptions?
-
Highcharts Options Widget.
getter/setter pair
- weight ↔ double?
-
The weight for all links with unspecified weights. The weight of a
link determines its thickness compared to other links.
getter/setter pair
- width ↔ double?
-
If no weight has previously been specified, this will set the width
of all the links without being compared to and scaled according to
other weights.
getter/setter pair
- zoomEnabled ↔ bool?
-
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.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