HighchartsTimelineSeriesDataLabelsOptions class

Highcharts Options Widget.

Inheritance

Constructors

HighchartsTimelineSeriesDataLabelsOptions.new({String? align, String? alignTo, bool? allowOverlap, bool? alternate, HighchartsSeriesDataLabelsAnimationOptions? animation, String? backgroundColor, String? borderColor, double? borderRadius, double? borderWidth, String? className, String? color, String? connectorColor, double? connectorWidth, bool? crop, bool? defer, String? distance, bool? enabled, HighchartsSeriesDataLabelsFilterOptions? filter, String? format, dynamic formatter, bool? inside, String? nullFormat, dynamic nullFormatter, String? overflow, double? padding, String? position, double? rotation, Map<String, String>? shadow, String? shape, HighchartsTimelineSeriesDataLabelsStyleOptions? style, HighchartsSeriesDataLabelsTextPathOptions? textPath, bool? useHTML, String? verticalAlign, double? width, double? x, double? y, double? zIndex})
Highcharts Options Widget.

Properties

align ↔ String?
The alignment of the data label compared to the point. If right, the right side of the label should be touching the point. For points with an extent, like columns, the alignments also dictates how to align it inside the box, as given with the inside option. Can be one of left, center or right.
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?
Highcharts Options Widget.
getter/setter pair
alternate ↔ bool?
Whether to position data labels alternately. For example, if distance is set equal to 100, then data labels will be positioned alternately (on both sides of the point) at a distance of 100px.
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?
Highcharts Options Widget.
getter/setter pair
borderRadius ↔ double?
Highcharts Options Widget.
getter/setter pair
borderWidth ↔ double?
Highcharts Options Widget.
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?
Highcharts Options Widget.
getter/setter pair
connectorColor ↔ String?
The color of the line connecting the data label to the point. The default color is the same as the point's color.
getter/setter pair
connectorWidth ↔ double?
The width of the line connecting the data label to the point.
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?
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
distance ↔ String?
A pixel value defining the distance between the data label and the point. Negative numbers puts the label on top of the point in a non-inverted chart. Defaults to 100 for horizontal and 20 for vertical timeline (chart.inverted: true).
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 ↔ dynamic
Highcharts Options Widget.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
inside ↔ bool?
For points with an extent, like columns or map areas, whether to align the data label inside the box or to the actual value point. Defaults to false in most cases, true in stacked columns.
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, String>?
Shadow options for the data label.
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 ↔ HighchartsTimelineSeriesDataLabelsStyleOptions?
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
width ↔ double?
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