HighchartsCMFSeriesOptions class

A CMF series. If the type option is not specified, it is inherited from chart.type.

Configuration options for the series are given in three levels:

  1. Options for all series in a chart are defined in the plotOptions.series object.
  2. Options for all cmf series are defined in plotOptions.cmf.
  3. Options for one single series are given in the series instance array.

API Docs: https://api.highcharts.com/highstock/series.cmf

Inheritance

Constructors

HighchartsCMFSeriesOptions.new({HighchartsSeriesAccessibilityOptions? accessibility, bool? allowPointSelect, dynamic animation, String? boostBlending, double? boostThreshold, String? className, bool? clip, String? color, double? colorIndex, String? colorKey, String? compare, double? compareBase, bool? compareStart, bool? compareToMain, bool? connectNulls, bool? crisp, double? cropThreshold, bool? cumulative, bool? cumulativeStart, String? cursor, Map<String, dynamic>? custom, String? dashStyle, HighchartsSeriesDataGroupingOptions? dataGrouping, List<HighchartsSeriesDataLabelsOptions>? dataLabels, HighchartsSeriesDataSortingOptions? dataSorting, String? description, bool? enableMouseTracking, HighchartsSeriesEventsOptions? events, String? findNearestPointBy, double? gapSize, String? gapUnit, bool? getExtremesFromAll, String? id, bool? inactiveOtherPoints, bool? includeInDataExport, double? index, HighchartsSeriesLabelOptions? label, HighchartsSeriesLastPriceOptions? lastPrice, HighchartsSeriesLastVisiblePriceOptions? lastVisiblePrice, double? legendIndex, String? legendSymbol, String? legendSymbolColor, double? lineWidth, String? linecap, String? linkedTo, HighchartsSeriesMarkerOptions? marker, String? negativeColor, bool? nullInteraction, HighchartsSeriesOnPointOptions? onPoint, double? opacity, HighchartsCMFSeriesParamsOptions? params, HighchartsSeriesPointOptions? point, dynamic pointDescriptionFormat, dynamic pointDescriptionFormatter, bool? relativeXValue, bool? selected, Map<String, dynamic>? shadow, bool? showCheckbox, bool? showInLegend, bool? skipKeyboardNavigation, bool? softThreshold, HighchartsSeriesSonificationOptions? sonification, dynamic stack, HighchartsSeriesStatesOptions? states, String? step, bool? stickyTracking, double? threshold, HighchartsCMFSeriesTooltipOptions? tooltip, double? turboThreshold, bool? visible, dynamic xAxis, dynamic yAxis, double? zIndex, String? zoneAxis, List<HighchartsSeriesZonesOptions>? zones})
A CMF series. If the type option is not specified, it is inherited from chart.type.

Properties

accessibility ↔ HighchartsSeriesAccessibilityOptions?
Accessibility options for a series.
getter/setter pair
allowPointSelect ↔ bool?
Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
getter/setter pair
animation ↔ dynamic
Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported:
getter/setter pair
boostBlending ↔ String?
Sets the color blending in the boost module.
getter/setter pair
boostThreshold ↔ double?
Set the point threshold for when a series should enter boost mode.
getter/setter pair
className ↔ String?
An additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element. Changes to the series' color will also be reflected in a chart's legend and tooltip.
getter/setter pair
clip ↔ bool?
Disable this option to allow series rendering in the whole plotting area.
getter/setter pair
color ↔ String?
The main color of the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
getter/setter pair
colorIndex ↔ double?
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
getter/setter pair
colorKey ↔ String?
Determines what data value should be used to calculate point color if colorAxis is used. Requires to set min and max if some custom point property is used or if approximation for data grouping is set to 'sum'.
getter/setter pair
compare ↔ String?
Compare the values of the series against the first non-null, non- zero value in the visible range. The y axis will show percentage or absolute change depending on whether compare is set to "percent" or "value". When this is applied to multiple series, it allows comparing the development of the series against each other. Adds a change field to every point object.
getter/setter pair
compareBase ↔ double?
When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.
getter/setter pair
compareStart ↔ bool?
Defines if comparison should start from the first point within the visible range or should start from the last point before the range.
getter/setter pair
compareToMain ↔ bool?
Whether to compare indicator to the main series values or indicator values.
getter/setter pair
connectNulls ↔ bool?
Whether to connect a graph line across null points, or render a gap between the two points on either side of the null.
getter/setter pair
crisp ↔ bool?
When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, setting crisp to false may look better, even though each column is rendered blurry.
getter/setter pair
cropThreshold ↔ double?
When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series.
getter/setter pair
cumulative ↔ bool?
Cumulative Sum feature replaces points' values with the following formula: sum of all previous points' values + current point's value. Works only for points in a visible range. Adds the cumulativeSum field to each point object that can be accessed e.g. in the tooltip.pointFormat.
getter/setter pair
cumulativeStart ↔ bool?
Defines if cumulation should start from the first point within the visible range or should start from the last point before the range.
getter/setter pair
cursor ↔ String?
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
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
dashStyle ↔ String?
Name of the dash style to use for the graph, or for some series types the outline of each shape.
getter/setter pair
dataGrouping ↔ HighchartsSeriesDataGroupingOptions?
Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts. Highcharts Stock by default applies data grouping when the points become closer than a certain pixel value, determined by the groupPixelWidth option.
getter/setter pair
dataLabels ↔ List<HighchartsSeriesDataLabelsOptions>?
Options for the series data labels, appearing next to each data point.
getter/setter pair
dataSorting ↔ HighchartsSeriesDataSortingOptions?
Options for the series data sorting.
getter/setter pair
description ↔ String?
A description of the series to add to the screen reader information about the series.
getter/setter pair
enableMouseTracking ↔ bool?
Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
getter/setter pair
events ↔ HighchartsSeriesEventsOptions?
General event handlers for the series items. These event hooks can also be attached to the series at run time using the Highcharts.addEvent function.
getter/setter pair
findNearestPointBy ↔ String?
Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to 'xy' for scatter series and 'x' for most other series. If the data has duplicate x-values, it is recommended to set this to 'xy' to allow hovering over all points.
getter/setter pair
gapSize ↔ double?
Defines when to display a gap in the graph, together with the gapUnit option.
getter/setter pair
gapUnit ↔ String?
Together with gapSize, this option defines where to draw gaps in the graph.
getter/setter pair
getExtremesFromAll ↔ bool?
Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String?
An id for the series. This can be used after render time to get a pointer to the series object through chart.get().
getter/setter pair
inactiveOtherPoints ↔ bool?
Highlight only the hovered point and fade the remaining points.
getter/setter pair
includeInDataExport ↔ bool?
When set to false will prevent the series data from being included in any form of data export.
getter/setter pair
index ↔ double?
The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
getter/setter pair
label ↔ HighchartsSeriesLabelOptions?
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.
getter/setter pair
lastPrice ↔ HighchartsSeriesLastPriceOptions?
The line marks the last price from all points.
getter/setter pair
lastVisiblePrice ↔ HighchartsSeriesLastVisiblePriceOptions?
The line marks the last price from visible range of points.
getter/setter pair
legendIndex ↔ double?
The sequential index of the series in the legend.
getter/setter pair
legendSymbol ↔ String?
What type of legend symbol to render for this series. Can be one of areaMarker, lineMarker or rectangle.
getter/setter pair
legendSymbolColor ↔ String?
Defines the color of the legend symbol for this series. Defaults to undefined, in which case the series color is used. Does not work with styled mode.
getter/setter pair
linecap ↔ String?
The SVG value used for the stroke-linecap and stroke-linejoin of a line graph. Round means that lines are rounded in the ends and bends.
getter/setter pair
lineWidth ↔ double?
Pixel width of the graph line.
getter/setter pair
linkedTo ↔ String?
The main series ID that indicator will be based on. Required for this indicator.
getter/setter pair
marker ↔ HighchartsSeriesMarkerOptions?
Options for the point markers of line and scatter-like series. Properties like fillColor, lineColor and lineWidth define the visual appearance of the markers. The symbol option defines the shape. Other series types, like column series, don't have markers, but have visual options on the series level instead.
getter/setter pair
negativeColor ↔ String?
The color for the parts of the graph or points that are below the threshold. Note that zones takes precedence over the negative color. Using negativeColor is equivalent to applying a zone with value of 0.
getter/setter pair
nullInteraction ↔ bool?
Whether or not data-points with the value of null should be interactive. When this is set to true, tooltips may highlight these points, and this option also enables keyboard navigation for such points. Format options for such points include nullFormat and nullFormater. Works for these series: line, spline, area, area-spline, column, bar, and* timeline.
getter/setter pair
onPoint ↔ HighchartsSeriesOnPointOptions?
Options for the Series on point feature. Only pie and sunburst series are supported at this moment.
getter/setter pair
opacity ↔ double?
Opacity of a series parts: line, fill (e.g. area) and dataLabels.
getter/setter pair
params ↔ HighchartsCMFSeriesParamsOptions?
Highcharts Options Widget.
getter/setter pair
point ↔ HighchartsSeriesPointOptions?
Properties for each single point.
getter/setter pair
pointDescriptionFormat ↔ dynamic
Same as accessibility.point.descriptionFormat, but for an individual series. Overrides the chart wide configuration.
getter/setter pair
pointDescriptionFormatter ↔ dynamic
Same as accessibility.series.descriptionFormatter, but for an individual series. Overrides the chart wide configuration.
getter/setter pair
relativeXValue ↔ bool?
When true, X values in the data set are relative to the current pointStart, pointInterval and pointIntervalUnit settings. This allows compression of the data for datasets with irregular X values.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selected ↔ bool?
Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name in the legend will be checked for a selected series.
getter/setter pair
shadow ↔ Map<String, dynamic>?
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
getter/setter pair
showCheckbox ↔ bool?
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
getter/setter pair
showInLegend ↔ bool?
Whether to display this particular series or series type in the legend. Standalone series are shown in legend by default, and linked series are not. Since v7.2.0 it is possible to show series that use colorAxis by setting this option to true.
getter/setter pair
skipKeyboardNavigation ↔ bool?
If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
getter/setter pair
softThreshold ↔ bool?
When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
getter/setter pair
sonification ↔ HighchartsSeriesSonificationOptions?
Sonification/audio chart options for a series.
getter/setter pair
stack ↔ dynamic
This option allows grouping series in a stacked chart. The stack option can be a string or anything else, as long as the grouped series' stack options match each other after conversion into a string.
getter/setter pair
states ↔ HighchartsSeriesStatesOptions?
Highcharts Options Widget.
getter/setter pair
step ↔ String?
Whether to apply steps to the line. Possible values are left, center and right.
getter/setter pair
stickyTracking ↔ bool?
Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip when not shared. When stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc.
getter/setter pair
threshold ↔ double?
The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.
getter/setter pair
tooltip ↔ HighchartsCMFSeriesTooltipOptions?
Highcharts Options Widget.
getter/setter pair
turboThreshold ↔ double?
When a series contains a data array that is longer than this, the Series class looks for data configurations of plain numbers or arrays of numbers. The first and last valid points are checked. If found, the rest of the data is assumed to be the same. This saves expensive data checking and indexing in long series, and makes data-heavy charts render faster.
getter/setter pair
visible ↔ bool?
Set the initial visibility of the series.
getter/setter pair
xAxis ↔ dynamic
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
getter/setter pair
yAxis ↔ dynamic
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.
getter/setter pair
zIndex ↔ double?
Define the visual z index of the series.
getter/setter pair
zoneAxis ↔ String?
Defines the Axis on which the zones are applied.
getter/setter pair
zones ↔ List<HighchartsSeriesZonesOptions>?
An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the zoneAxis option. The zone definitions have to be in ascending order regarding to the value.
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