HighchartsArcDiagramSeriesDataLabelsOptions class

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.

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

Inheritance

Constructors

HighchartsArcDiagramSeriesDataLabelsOptions.new({String? align, String? alignTo, bool? allowOverlap, HighchartsSeriesDataLabelsAnimationOptions? animation, String? backgroundColor, String? borderColor, double? borderRadius, double? borderWidth, String? className, String? color, bool? crop, bool? defer, bool? enabled, HighchartsSeriesDataLabelsFilterOptions? filter, String? format, dynamic formatter, bool? inside, HighchartsArcDiagramSeriesDataLabelsLinkTextPathOptions? linkTextPath, String? nodeFormat, dynamic nodeFormatter, String? nullFormat, dynamic nullFormatter, String? overflow, double? padding, String? position, double? rotation, Map<String, dynamic>? shadow, String? shape, Map<String, String>? style, HighchartsSeriesDataLabelsTextPathOptions? textPath, bool? useHTML, String? verticalAlign, double? x, double? y, double? zIndex})
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.

Properties

align ↔ String?
Highcharts Options Widget.
getter/setter pair
alignTo ↔ String?
Alignment method for data labels. If set to plotEdges, the labels are aligned within the plot area in the direction of the y-axis. So in a regular column chart, the labels are aligned vertically according to the verticalAlign setting. In a bar chart, which is inverted, the labels are aligned horizontally according to the align setting. Applies to cartesian series only.
getter/setter pair
allowOverlap ↔ bool?
Whether to allow data labels to overlap. To make the labels less sensitive for overlapping, the dataLabels.padding can be set to 0.
getter/setter pair
animation ↔ HighchartsSeriesDataLabelsAnimationOptions?
Enable or disable the initial animation when a series is displayed for the dataLabels. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation.
getter/setter pair
backgroundColor ↔ String?
Highcharts Options Widget.
getter/setter pair
borderColor ↔ String?
The border color for the data label. Setting it to auto will use the point's color. Defaults to undefined.
getter/setter pair
borderRadius ↔ double?
The border radius in pixels for the data label.
getter/setter pair
borderWidth ↔ double?
The border width in pixels for the data label.
getter/setter pair
className ↔ String?
A class name for the data label. Particularly in styled mode, this can be used to give each series' or point's data label unique styling. In addition to this option, a default color class name is added so that we can give the labels a contrast text shadow.
getter/setter pair
color ↔ String?
This options is deprecated. Use style.color instead.
getter/setter pair
crop ↔ bool?
Highcharts Options Widget.
getter/setter pair
defer ↔ bool?
Whether to defer displaying the data labels until the initial series animation has finished. Setting to false renders the data label immediately. If set to true inherits the defer time set in plotOptions.series.animation.
getter/setter pair
enabled ↔ bool?
Highcharts Options Widget.
getter/setter pair
filter ↔ HighchartsSeriesDataLabelsFilterOptions?
A declarative filter to control of which data labels to display. The declarative filter is designed for use when callback functions are not available, like when the chart options require a pure JSON structure or for use with graphical editors. For programmatic control, use the formatter instead, and return undefined to disable a single data label.
getter/setter pair
format ↔ String?
Highcharts Options Widget.
getter/setter pair
formatter ↔ dynamic
Highcharts Options Widget.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
inside ↔ bool?
Highcharts Options Widget.
getter/setter pair
linkTextPath ↔ HighchartsArcDiagramSeriesDataLabelsLinkTextPathOptions?
Options for a link label text which should follow link connection. Border and background are disabled for a label that follows a path.
getter/setter pair
nodeFormat ↔ String?
The format string specifying what to show for nodes in the sankey diagram. By default the nodeFormatter returns {point.name}.
getter/setter pair
nodeFormatter ↔ dynamic
Callback to format data labels for nodes in the sankey diagram. The nodeFormat option takes precedence over the nodeFormatter.
getter/setter pair
nullFormat ↔ String?
Format for points with the value of null. Works analogously to format. nullFormat can be applied only to series which support displaying null points. heatmap and tilemap supports nullFormat by default while the following series requires #series.nullInteraction set to true: line, spline, area, area-spline, column, bar, and timeline. Does not work with series that don't display null points, like pie.
getter/setter pair
nullFormatter ↔ dynamic
Callback JavaScript function that defines formatting for points with the value of null. Works analogously to formatter. nullFormatter can be applied only to series which support displaying null points. heatmap and tilemap supports nullFormatter by default while the following series requires #series.nullInteraction set to true: line, spline, area, area-spline, column, bar, and timeline. Does not work with series that don't display null points, like pie.
getter/setter pair
overflow ↔ String?
How to handle data labels that flow outside the plot area. The default is "justify", which aligns them inside the plot area. For columns and bars, this means it will be moved inside the bar. To display data labels outside the plot area, set crop to false and overflow to "allow".
getter/setter pair
padding ↔ double?
When either the borderWidth or the backgroundColor is set, this is the padding within the box.
getter/setter pair
position ↔ String?
Aligns data labels relative to points. If center alignment is not possible, it defaults to right.
getter/setter pair
rotation ↔ double?
Text rotation in degrees. Note that due to a more complex structure, backgrounds, borders and padding will be lost on a rotated data label.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shadow ↔ Map<String, dynamic>?
The shadow of the box. Works best with borderWidth or backgroundColor. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
getter/setter pair
shape ↔ String?
The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer object.
getter/setter pair
style ↔ Map<String, String>?
Styles for the label. The default color setting is "contrast", which is a pseudo color that Highcharts picks up and applies the maximum contrast to the underlying point item, for example the bar in a bar chart.
getter/setter pair
textPath ↔ HighchartsSeriesDataLabelsTextPathOptions?
Options for a label text which should follow marker's shape. Border and background are disabled for a label that follows a path.
getter/setter pair
useHTML ↔ bool?
Whether to use HTML to render the labels.
getter/setter pair
verticalAlign ↔ String?
Highcharts Options Widget.
getter/setter pair
x ↔ double?
The x position offset of the label relative to the point in pixels.
getter/setter pair
y ↔ double?
The y position offset of the label relative to the point in pixels.
getter/setter pair
zIndex ↔ double?
The z index of the data labels. Use a zIndex of 6 to display it above the series, or use a zIndex of 2 to display it behind 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