HighchartsSunburstSeriesLevelsDataLabelsOptions class

Can set dataLabels on all points which lies on the same level.

API Docs: https://api.highcharts.com/highcharts/series.sunburst.levels.dataLabels

Inheritance

Constructors

HighchartsSunburstSeriesLevelsDataLabelsOptions.new({bool? allowOverlap, bool? defer, String? rotationMode, HighchartsSunburstSeriesLevelsDataLabelsStyleOptions? style, String? alignTo, String? connectorColor, double? connectorPadding, String? connectorShape, double? connectorWidth, String? crookDistance, dynamic distance, bool? enabled, String? format, String? formatter, bool? softConnector, HighchartsSeriesDataLabelsAnimationOptions? animation, String? backgroundColor, String? borderColor, double? borderRadius, double? borderWidth, String? className, String? color, bool? crop, HighchartsSeriesDataLabelsFilterOptions? filter, String? nullFormat, dynamic nullFormatter, String? overflow, double? padding, String? position, double? rotation, Map<String, dynamic>? shadow, String? shape, HighchartsSeriesDataLabelsTextPathOptions? textPath, bool? useHTML, String? verticalAlign, double? x, double? y, double? zIndex})
Can set dataLabels on all points which lies on the same level.

Properties

alignTo ↔ String?
Alignment method for data labels. Possible values are:
getter/setter pair
allowOverlap ↔ bool?
Highcharts Options Widget.
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?
The background color or gradient for the data label. Setting it to auto will use the point's color.
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
connectorColor ↔ String?
The color of the line connecting the data label to the pie slice. The default color is the same as the point's color.
getter/setter pair
connectorPadding ↔ double?
The distance from the data label to the connector. Note that data labels also have a default padding, so in order for the connector to touch the text, the padding must also be 0.
getter/setter pair
connectorShape ↔ String?
Specifies the method that is used to generate the connector path. Highcharts provides 3 built-in connector shapes: 'crookedLine' (default since v11), 'fixedOffset' and 'straight'.
getter/setter pair
connectorWidth ↔ double?
The width of the line connecting the data label to the pie slice.
getter/setter pair
crookDistance ↔ String?
Works only if connectorShape is 'crookedLine'. It defines how far from the vertical plot edge the coonnector path should be crooked. With the default, undefined, the crook is placed so that the horizontal line from the label intersects with the radial line extending through the center of the pie slice.
getter/setter pair
crop ↔ bool?
Whether to hide data labels that are outside the plot area. By default, the data label is moved inside the plot area according to the overflow option.
getter/setter pair
defer ↔ bool?
Highcharts Options Widget.
getter/setter pair
distance ↔ dynamic
The distance of the data label from the pie's edge. Negative numbers put the data label on top of the pie slices. Can also be defined as a percentage of pie's radius. Connectors are only shown for data labels outside the pie.
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?
A format string for the data label. Available variables are the same as for formatter.
getter/setter pair
formatter ↔ String?
Callback JavaScript function to format the data label. Note that if a format is defined, the format takes precedence and the formatter is ignored.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
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
rotationMode ↔ String?
Decides how the data label will be rotated relative to the perimeter of the sunburst. Valid values are circular, auto, parallel and perpendicular. When circular, the best fit will be computed for the point, so that the label is curved around the center when there is room for it, otherwise perpendicular. The legacy auto option works similar to circular, but instead of curving the labels they are tangent to the perimeter.
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
softConnector ↔ bool?
Whether to render the connector as a soft arc or a line with a sharp break. Works only if connectorShape equals to fixedOffset.
getter/setter pair
style ↔ HighchartsSunburstSeriesLevelsDataLabelsStyleOptions?
Highcharts Options Widget.
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?
The vertical alignment of a data label. Can be one of top, middle or bottom. The default value depends on the data, for instance in a column chart, the label is above positive values and below negative values.
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