HCPlotSeriesOptions class

(Highcharts, Highstock, Highmaps, Gantt) General options for all series types.

Implemented types

Constructors

HCPlotSeriesOptions({HCSeriesAccessibilityOptionsObject? accessibility, bool? allowPointSelect, dynamic animation, num? animationLimit, String? boostBlending, num? boostThreshold, dynamic borderColor, num? borderWidth, String? className, bool? clip, dynamic color, dynamic colorAxis, num? colorIndex, String? colorKey, String? compare, dynamic compareBase, bool? compareStart, bool? connectEnds, bool? connectNulls, HCSeriesConnectorsOptionsObject? connectors, bool? crisp, num? cropThreshold, bool? cumulative, bool? cumulativeStart, String? cursor, HCDictionary? custom, String? dashStyle, HCDataGroupingOptionsObject? dataGrouping, dynamic dataLabels, HCDataMappingOptionsObject? dataMapping, HCPlotSeriesDataSortingOptions? dataSorting, String? description, HCSeriesDragDropOptionsObject? dragDrop, bool? enableMouseTracking, HCSeriesEventsOptionsObject? events, String? findNearestPointBy, num? gapSize, String? gapUnit, bool? getExtremesFromAll, bool? inactiveOtherPoints, bool? includeInDataExport, dynamic joinBy, List<String>? keys, HCSeriesLabelOptionsObject? label, HCSeriesLastPriceOptionsObject? lastPrice, HCSeriesLastVisiblePriceOptionsObject? lastVisiblePrice, String? legendSymbol, dynamic legendSymbolColor, String? linecap, num? lineWidth, String? linkedTo, HCPointMarkerOptionsObject? marker, HCPlotSeriesOptions? navigatorOptions, dynamic negativeColor, bool? nullInteraction, dynamic onPoint, num? opacity, HCPlotSeriesPointOptions? point, dynamic pointDescriptionFormat, dynamic pointDescriptionFormatter, num? pointInterval, String? pointIntervalUnit, dynamic pointPlacement, num? pointRange, dynamic pointStart, bool? relativeXValue, bool? selected, dynamic shadow, bool? showCheckbox, bool? showInLegend, bool? showInNavigator, bool? skipKeyboardNavigation, bool? softThreshold, HCSeriesSonificationOptions? sonification, String? stacking, HCSeriesStatesOptionsObject? states, String? step, bool? stickyTracking, num? threshold, HCSeriesTooltipOptionsObject? tooltip, num? turboThreshold, bool? useOhlcData, bool? visible, num? zIndex, String? zoneAxis, List<HCSeriesZonesOptionsObject>? zones, bool? zoomEnabled})
const

Properties

accessibility → HCSeriesAccessibilityOptionsObject?
(Highcharts, Highstock, Highmaps, Gantt) Accessibility options for a series.
final
allowPointSelect → bool?
(Highcharts, Highstock, Highmaps, Gantt) Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
final
animation → dynamic
(Highcharts, Highstock, Highmaps, Gantt) 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
final
animationLimit → num?
(Highcharts, Highstock, Highmaps, Gantt) For some series, there is a limit that shuts down animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation does not run if there is more than 250 points totally. To disable t
final
boostBlending → String?
(Highcharts, Highstock, Highmaps, Gantt) Sets the color blending in the boost module.
final
boostThreshold → num?
(Highcharts, Highstock, Highmaps, Gantt) Set the point threshold for when a series should enter boost mode.
final
borderColor → dynamic
(Highmaps) The border color of the map areas.
final
borderWidth → num?
(Highmaps) The border width of each map area.
final
className → String?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
clip → bool?
(Highcharts, Highstock, Highmaps, Gantt) Disable this option to allow series rendering in the whole plotting area.
final
color → dynamic
(Highcharts, Highstock, Highmaps, Gantt) 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 a
final
colorAxis → dynamic
(Highcharts, Highstock, Highmaps) When using dual or multiple color axes, this number defines which colorAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the colorAxis array, with 0 being the first. Set this option to false to prevent a series f
final
colorIndex → num?
(Highcharts, Highstock, Highmaps, Gantt) Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
final
colorKey → String?
(Highcharts, Highstock, Highmaps) 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'.
final
compare → String?
(Highstock) 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 develo
final
compareBase → dynamic
(Highstock) When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.
final
compareStart → bool?
(Highstock) Defines if comparison should start from the first point within the visible range or should start from the last point before the range.
final
connectEnds → bool?
(Highcharts) Polar charts only. Whether to connect the ends of a line series plot across the extremes.
final
connectNulls → bool?
(Highcharts, Highstock) Whether to connect a graph line across null points, or render a gap between the two points on either side of the null.
final
connectors → HCSeriesConnectorsOptionsObject?
(Gantt) Override Pathfinder connector options for a series. Requires Highcharts Gantt to be loaded.
final
crisp → bool?
(Highcharts, Highstock, Gantt) 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, settin
final
cropThreshold → num?
(Highcharts, Highstock) 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 th
final
cumulative → bool?
(Highstock) 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.
final
cumulativeStart → bool?
(Highstock) Defines if cumulation should start from the first point within the visible range or should start from the last point before the range.
final
cursor → String?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
custom → HCDictionary?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
dashStyle → String?
(Highcharts, Highstock, Highmaps, Gantt) Name of the dash style to use for the graph, or for some series types the outline of each shape.
final
dataGrouping → HCDataGroupingOptionsObject?
(Highstock) 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 `group
final
dataLabels → dynamic
(Highcharts, Highstock, Highmaps, Gantt) Options for the series data labels, appearing next to each data point.
final
dataMapping → HCDataMappingOptionsObject?
(Highcharts, Highstock, Highmaps, Gantt) The mapping between the data table and the series data points. This is used in conjunction with the dataTable option (on chart or series level) to map columns from the data table to the properties of the data points. The keys of the dataMapping object cor
final
dataSorting → HCPlotSeriesDataSortingOptions?
(Highcharts, Highstock) Options for series data sorting.
final
description → String?
(Highcharts, Highstock, Highmaps, Gantt) Deprecated. Use plotOptions.series.accessibility.description instead.
final
dragDrop → HCSeriesDragDropOptionsObject?
(Highcharts, Highstock, Highmaps, Gantt) The draggable-points module allows points to be moved around or modified in the chart. In addition to the options mentioned under the dragDrop API structure, the module fires three events, point.dragStart, point.drag and point.drop.
final
enableMouseTracking → bool?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
events → HCSeriesEventsOptionsObject?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
findNearestPointBy → String?
(Highcharts, Highstock, Highmaps, Gantt) 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 t
final
gapSize → num?
(Highcharts, Highstock) Defines when to display a gap in the graph, together with the gapUnit option.
final
gapUnit → String?
(Highcharts, Highstock) Together with gapSize, this option defines where to draw gaps in the graph.
final
getExtremesFromAll → bool?
(Highcharts, Highstock, Gantt) 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.
final
hashCode → int
The hash code for this object.
no setterinherited
inactiveOtherPoints → bool?
(Highcharts, Highstock, Highmaps, Gantt) Highlight only the hovered point and fade the remaining points.
final
includeInDataExport → bool?
(Highcharts, Highstock, Highmaps, Gantt) When set to false will prevent the series data from being included in any form of data export.
final
joinBy → dynamic
(Highmaps) What property to join the mapData to the value data. For example, if joinBy is "code", the mapData items with a specific code is merged into the data with the same code. For maps loaded from GeoJSON, the keys may be held in each point's properties object.
final
keys → List<String>?
(Highcharts, Highstock, Highmaps, Gantt) An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.
final
label → HCSeriesLabelOptionsObject?
(Highcharts, Highstock, Gantt) 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.
final
lastPrice → HCSeriesLastPriceOptionsObject?
(Highstock) The line marks the last price from all points.
final
lastVisiblePrice → HCSeriesLastVisiblePriceOptionsObject?
(Highstock) The line marks the last price from visible range of points.
final
legendSymbol → String?
(Highcharts, Highstock, Highmaps, Gantt) What type of legend symbol to render for this series. Can be one of areaMarker, lineMarker or rectangle.
final
legendSymbolColor → dynamic
(Highcharts, Highstock, Highmaps) 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.
final
linecap → String?
(Highcharts, Highstock, Highmaps, Gantt) The line cap used for line ends and line joins on the graph.
final
lineWidth → num?
(Highcharts, Highstock) Pixel width of the graph line.
final
linkedTo → String?
(Highcharts, Highstock, Gantt) The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
final
marker → HCPointMarkerOptionsObject?
(Highcharts, Highstock, Highmaps, Gantt) 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 mark
final
(Highstock) Options for the corresponding navigator series if showInNavigator is true for this series. Available options are the same as any series, documented at plotOptions and series.
final
negativeColor → dynamic
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
nullInteraction → bool?
(Highcharts, Highstock) 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 `nullFormatter
final
onPoint → dynamic
(Highcharts, Highstock, Highmaps, Gantt) Options for the Series on point feature. Only pie and sunburst series are supported at this moment.
final
opacity → num?
(Highcharts, Highstock, Highmaps, Gantt) Opacity of a series parts: line, fill (e.g. area) and dataLabels.
final
point → HCPlotSeriesPointOptions?
(Highcharts, Highstock, Highmaps, Gantt) Properties for each single point.
final
pointDescriptionFormat → dynamic
(Highcharts, Highstock, Highmaps, Gantt) Deprecated. Use series.accessibility.point.descriptionFormat instead.
final
pointDescriptionFormatter → dynamic
(Highcharts, Highstock, Highmaps, Gantt) Deprecated. Use series.accessibility.point.descriptionFormatter instead.
final
pointInterval → num?
(Highcharts, Highstock, Gantt) If no x values are given for the points in a series, pointInterval defines the interval of the x values. For example, if a series contains one value every decade starting from year 0, set pointInterval to 10. In true datetime axes, the pointInterval is set in
final
pointIntervalUnit → String?
(Highcharts, Highstock, Gantt) On datetime series, this allows for setting the pointInterval to irregular time units, day, month and year. A day is usually the same as 24 hours, but pointIntervalUnit also takes the DST crossover into consideration when dealing with local time. Combine this o
final
pointPlacement → dynamic
(Highcharts, Highstock, Gantt) Possible values: "on", "between", number.
final
pointRange → num?
(Highstock) The width of each point on the x axis. For example in a column chart with one value each day, the pointRange would be 1 day (= 24 * 3600
final
pointStart → dynamic
(Highcharts, Highstock, Gantt) If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
final
relativeXValue → bool?
(Highcharts, Highstock) 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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selected → bool?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
shadow → dynamic
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
showCheckbox → bool?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
showInLegend → bool?
(Highcharts, Highstock, Highmaps, Gantt) 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.
final
showInNavigator → bool?
(Highstock) Whether or not to show the series in the navigator. Takes precedence over navigator.baseSeries if defined.
final
skipKeyboardNavigation → bool?
(Highcharts, Highstock, Highmaps, Gantt) Deprecated. Use series.accessibility.keyboardNavigation instead.
final
softThreshold → bool?
(Highcharts, Highstock) 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.
final
sonification → HCSeriesSonificationOptions?
(Highcharts, Highstock, Highmaps, Gantt) Sonification/audio chart options for a series.
final
stacking → String?
(Highcharts, Highstock) Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent".
final
states → HCSeriesStatesOptionsObject?
(Highcharts, Highstock, Highmaps, Gantt) A collection of options for different series states.
final
step → String?
(Highcharts, Highstock) Whether to apply steps to the line. Possible values are left, center and right.
final
stickyTracking → bool?
(Highcharts, Highstock, Highmaps, Gantt) 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 th
final
threshold → num?
(Highcharts, Highstock) The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.
final
tooltip → HCSeriesTooltipOptionsObject?
(Highcharts, Highstock, Highmaps, Gantt) A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
final
turboThreshold → num?
(Highcharts, Highstock, Gantt) 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 expen
final
useOhlcData → bool?
(Highstock) The parameter allows setting line series type and use OHLC indicators. Data in OHLC format is required.
final
visible → bool?
(Highcharts, Highstock, Highmaps, Gantt) Set the initial visibility of the series.
final
zIndex → num?
(Highmaps) Define the z index of the series.
final
zoneAxis → String?
(Highcharts, Highstock) Defines the Axis on which the zones are applied.
final
zones → List<HCSeriesZonesOptionsObject>?
(Highcharts, Highstock) 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.
final
zoomEnabled → bool?
(Highcharts, Highstock, Highmaps, Gantt) Whether to zoom non-cartesian series. If chart.zooming is set, the option allows to disable zooming on an individual non-cartesian series. By default zooming is enabled for all series.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited