HighchartsSeriesLabelOptions class

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.

The series labels currently work with series types having a graph or an area.

API Docs: https://api.highcharts.com/highcharts/series.zigzag.label

Inheritance

Constructors

HighchartsSeriesLabelOptions.new({List<Map<String, dynamic>>? boxesToAvoid, bool? connectorAllowed, double? connectorNeighbourDistance, bool? enabled, String? format, dynamic formatter, double? maxFontSize, double? minFontSize, bool? onArea, HighchartsSeriesLabelStyleOptions? style, bool? useHTML})
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.

Properties

boxesToAvoid ↔ List<Map<String, dynamic>>?
An array of boxes to avoid when laying out the labels. Each item has a left, right, top and bottom property.
getter/setter pair
connectorAllowed ↔ bool?
Allow labels to be placed distant to the graph if necessary, and draw a connector line to the graph. Setting this option to true may decrease the performance significantly, since the algorithm with systematically search for open spaces in the whole plot area. Visually, it may also result in a more cluttered chart, though more of the series will be labeled.
getter/setter pair
connectorNeighbourDistance ↔ double?
If the label is closer than this to a neighbour graph, draw a connector.
getter/setter pair
enabled ↔ bool?
Enable the series label per series.
getter/setter pair
format ↔ String?
A format string for the label, with support for a subset of HTML. Variables are enclosed by curly brackets. Available variables are name, options.xxx, color and other members from the series object. Use this option also to set a static text for the label.
getter/setter pair
formatter ↔ dynamic
Callback function to format each of the series' labels. The this keyword refers to the series object. By default the formatter is undefined and the series.name is rendered.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
maxFontSize ↔ double?
For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series.
getter/setter pair
minFontSize ↔ double?
For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series.
getter/setter pair
onArea ↔ bool?
Draw the label on the area of an area series. By default it is drawn on the area. Set it to false to draw it next to the graph instead.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
style ↔ HighchartsSeriesLabelStyleOptions?
Styles for the series label. The color defaults to the series color, or a contrast color if onArea.
getter/setter pair
useHTML ↔ bool?
Whether to use HTML to render the series label.
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