HighchartsTimelineSeriesDataOptions class
An array of data points for the series. For the timeline
series type,
points can be given with three general parameters, name
, label
,
and description
:
Example:
If all points additionally have the x
values, and xAxis type is set to
datetime
, then events are laid out on a true time axis, where their
placement reflects the actual time between them.
API Docs: https://api.highcharts.com/highcharts/series.timeline.data
- Inheritance
-
- Object
- HighchartsOptionsBase
- HighchartsTimelineSeriesDataOptions
Constructors
-
HighchartsTimelineSeriesDataOptions.new({HighchartsTimelineSeriesDataAccessibilityOptions? accessibility, String? className, String? color, double? colorIndex, Map<
String, dynamic> ? custom, List<HighchartsTimelineSeriesDataDataLabelsOptions> ? dataLabels, String? description, HighchartsTimelineSeriesDataDragDropOptions? dragDrop, String? drilldown, HighchartsTimelineSeriesDataEventsOptions? events, String? id, String? label, double? labelrank, String? name, bool? selected, dynamic x}) -
An array of data points for the series. For the
timeline
series type, points can be given with three general parameters,name
,label
, anddescription
:
Properties
- accessibility ↔ HighchartsTimelineSeriesDataAccessibilityOptions?
-
Accessibility options for a data point.
getter/setter pair
- className ↔ String?
-
An additional, individual class name for the data point's graphic
representation. Changes to a point's color will also be reflected in a
chart's legend and tooltip.
getter/setter pair
- color ↔ String?
-
Individual color for the point. By default the color is pulled from
the global
colors
array.getter/setter pair - colorIndex ↔ double?
-
A specific color index to use for the point, so its graphic representations
are given the class name
highcharts-color-{n}
. In styled mode this will change the color of the graphic. In non-styled mode, the color is set by thefill
attribute, so the change in class name won't have a visual effect by default.getter/setter pair -
custom
↔ Map<
String, dynamic> ? -
A reserved subspace to store options and values for customized functionality.
Here you can add additional data for your own event callbacks and formatter
callbacks.
getter/setter pair
-
dataLabels
↔ List<
HighchartsTimelineSeriesDataDataLabelsOptions> ? -
Individual data label for each point. The options are the same as
the ones for plotOptions.series.dataLabels.
getter/setter pair
- description ↔ String?
-
The description of event. This description will be shown in tooltip.
getter/setter pair
- dragDrop ↔ HighchartsTimelineSeriesDataDragDropOptions?
-
Point specific options for the draggable-points module. Overrides options
on
series.dragDrop
.getter/setter pair - drilldown ↔ String?
-
The
id
of a series in the drilldown.series array to use for a drilldown for this point.getter/setter pair - events ↔ HighchartsTimelineSeriesDataEventsOptions?
-
The individual point events.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- id ↔ String?
-
An id for the point. This can be used after render time to get a
pointer to the point object through
chart.get()
.getter/setter pair - label ↔ String?
-
The label of event.
getter/setter pair
- labelrank ↔ double?
-
The rank for this point's data label in case of collision. If two
data labels are about to overlap, only the one with the highest
labelrank
will be drawn.getter/setter pair - name ↔ String?
-
The name of event.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selected ↔ bool?
-
Whether the data point is selected initially.
getter/setter pair
- x ↔ dynamic
-
The x value of the point.
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