HISeries Class Reference

An array of data points for the series. The points can be given in three ways:

1. An array of numerical values. In this case, the numerical values will be interpreted as y values, and x values will be automatically calculated, either starting at 0 and incrementing by 1, or from pointStart and pointInterval given in the plotOptions. If the axis is has categories, these will be used. This option is not available for range series. Example:

data: [0, 5, 3, 5]

2. An array of arrays with two values. In this case, the first value is the x value and the second is the y value. If the first value is a string, it is applied as the name of the point, and the x value is incremented following the above rules. For range series, the arrays will be interpreted as [x, low, high]. In this cases, the X value can be skipped altogether to make use of pointStart and pointRange. Example:

data: [
     [0, 9],
     [1, 2],
     [2, 8]
]

3. An array of objects with named values. In this case the objects are point configuration objects as seen below. Range series values are given by low and high. Example:

data: [{
     x: 1,
     y: 9,
     name: "Point2",
     color: "#00FF00"
}, {
     x: 1,
     y: 0,
     name: "Point1",
     color: "#FF00FF"
}]

Note that line series and derived types like spline and area, require data to be sorted by X because it interpolates mouse coordinates for the tooltip. Column and scatter series, where each point has its own mouse event, does not require sorting.

An id for the series. This can be used after render time to get a pointer to the series object through chart.get().

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.

The sequential index of the series in the legend. Try it: Legend in opposite order .

The name of the series as shown in the legend, tooltip etc.

This option allows grouping series in a stacked chart. The stack option can be a string or a number or anything else, as long as the grouped series' stack options match each other.

The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter or spline. From version 2.3, arearange, areasplinerange and columnrange are supported with the highcharts-more.js component.

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.

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.

Define the visual z index of the series.

Formatter function to use instead of the default for series descriptions. Receives one argument, series, referring to the series to describe. Should return a string with the description of the series for a screen reader user. If false is returned, the default formatter will be used for that series.

When a series contains more points than this, we no longer expose information about individual points to screen readers. Set to false to disable.

Format to use for describing the data series group to assistive technology - including screen readers. The series context and its subproperties are available under the variable {series}, for example {series.name} for the series name, and {series.points.length} for the number of data points. The chart context and its subproperties are available under the variable {chart}, for example {chart.series.length} for the number of series in the chart. {seriesDescription} refers to the automatic description of the series type and number of points added by Highcharts by default. {authorDescription} refers to the description added in series.description if one is present. {axisDescription} refers to the description added if the chart has multiple X or Y axes. Note that if series.descriptionFormatter is declared it will take precedence, and this option will be overridden.

Whether or not to add series descriptions to charts with a single series.

User supplied description text. This is added in the point comment description by default if present. {description} refers to the value given in point.accessibility.description.

xAxis description for series if there are multiple xAxes in the chart.

yAxis description for series if there are multiple yAxes in the chart.

Description for annotations on a point, as it is made available to assistive technology.

Lang configuration for the series main summary. Each series type has two modes: 1. This series type is the only series type used in the chart 2. This is a combination chart with multiple series types If a definition does not exist for the specific series type and mode, the ‘default’ lang definitions are used. Chart and its subproperties can be accessed with the {chart} variable. The series and its subproperties can be accessed with the {series} variable. The series index (starting from 1) can be accessed with the {seriesNumber} variable.

Description for the value of null points.

When set to false will prevent the series data from being included in any form of data export. Since version 6.0.0 until 7.1.0 the option was existing undocumented as includeInCSVExport.

Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}. Since v11, CSS variables on the form --highcharts-color-{n} make changing the color scheme very convenient.

Disable this option to allow series rendering in the whole plotting area. Note: Clipping should be always enabled when chart.zoomType is set

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.

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. In styled mode, the color can be defined by the colorIndex option. Also, the series color can be set with the .highcharts-series, .highcharts-color-{n}, .highcharts-{type}-series or .highcharts-series-{n} class, or individual classes given by the className option.

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 milliseconds. It can be also be combined with pointIntervalUnit to draw irregular time intervals. If combined with relativeXValue, an x value can be set on each point, and the pointInterval is added x times to the pointStart setting. Please note that this options applies to the series data, not the interval of the axis ticks, which is independent.

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.

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'.

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. For example, if softThreshold is false, a series of 0, 1, 2, 3 will make the Y axis show negative values according to the minPadding option. If softThreshold is true, the Y axis starts at 0.

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.

Properties for each single point.

Options for the series data sorting.

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. In styled mode, the markers can be styled with the .highcharts-point, .highcharts-point-hover and .highcharts-point-select class names.

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.

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. The series labels currently work with series types having a graph or an area.

Same as accessibility.series.descriptionFormatter, but for an individual series. Overrides the chart wide configuration.

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. In styled mode, the series cursor can be set with the same classes as listed under series.color.

Name of the dash style to use for the graph, or for some series types the outline of each shape. In styled mode, the stroke dash-array can be set with the same classes as listed under series.color.

Possible values: "on", "between", number. In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart. Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won’t affect axis padding. Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set. For the xrange series type and gantt charts, if the Y axis is a category axis, the pointPlacement applies to the Y axis rather than the (typically datetime) X axis. Defaults to undefined in cartesian charts, "between" in polar charts.

Whether to connect a graph line across null points, or render a gap between the two points on either side of the null. In stacked area chart, if connectNulls is set to true, null points are interpreted as 0.

Highlight only the hovered point and fade the remaining points. Scatter-type series require enabling the ‘inactive’ marker state and adjusting opacity. Note that this approach could affect performance with large datasets.

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.

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.

Options for the Series on point feature. Only pie and sunburst series are supported at this moment.

Whether to stack the values of each series on top of each other. Possible values are undefined to disable, "normal" to stack by value or "percent". When stacking is enabled, data must be sorted in ascending X order. Some stacking options are related to specific series types. In the streamgraph series type, the stacking option is set to "stream". The second one is "overlap", which only applies to waterfall series.

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: - defer: The animation delay time in milliseconds. - duration: The duration of the animation in milliseconds. (Defaults to 1000) - easing: Can be a string reference to an easing function set on the Math object or a function. See the Custom easing function demo below. (Defaults to easeInOutSine) Due to poor performance, animation is disabled in old IE browsers for several chart types.

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. Applies only to series types using nearest neighbor search (not direct hover) for tooltip.

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. The real X values are computed on the formula f(x) = ax + b, where a is the pointInterval (optionally with a time unit given by pointIntervalUnit), and b is the pointStart.

The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.

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.

Sets the color blending in the boost module.

What type of legend symbol to render for this series. Can be one of areaMarker, lineMarker or rectangle.

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.

Same as accessibility.point.descriptionFormat, but for an individual series. Overrides the chart wide configuration.

Opacity of a series parts: line, fill (e.g.area) and dataLabels.

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 this cap, set animationLimit to Infinity. This option works if animation is fired on individual points, not on a group of points like e.g. during the initial animation.

When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to 0 disable. Note: In boost mode turbo threshold is forced. Only array of numbers or two dimensional arrays are allowed.

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.

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.

If set to true, the accessibility module will skip past the points in this series for keyboard navigation.

Accessibility options for a series.

Whether to apply steps to the line. Possible values are left, center and right.

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.

Sonification/audio chart options for a series.

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. Note that in some cases, like stacked columns or other dense layouts, the series may cast shadows on each other. In that case, the chart.seriesGroupShadow allows applying a common drop shadow to the whole series group.

Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc). The selected points can be handled by point select and unselect events, or collectively by the getSelectedPoints function. And alternative way of selecting points is through dragging.

When using dual or multiple color axes, this number defines which colorAxis the particular series is connected to. It refers to either the {@link #colorAxis.id|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 from connecting to the default color axis. Since v7.2.0 the option can also be an axis id or an axis index instead of a boolean flag.

Defines the Axis on which the zones are applied.

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. In styled mode, the color zones are styled with the .highcharts-zone-{n} class, or custom classed from the className option (view live demo).

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 option with pointInterval to draw weeks, quarters, 6 months, 10 years etc. Please note that this options applies to the series data, not the interval of the axis ticks, which is independent.

Pixel width of the graph line.

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.

Set the initial visibility of the series.

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. If master series uses data sorting and linked series does not have its own sorting definition, the linked series will be sorted in the same order as the master one.

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. Note: The boost module will force this option because of technical limitations.

Options for the series data labels, appearing next to each data point. Since v6.2.0, multiple data labels can be applied to each single point by defining them as an array of configs. In styled mode, the data labels can be styled with the .highcharts-data-label-box and .highcharts-data-label class names (see example).

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.

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. If combined with relativeXValue, an x value can be set on each point. The x value from the point options is multiplied by pointInterval and added to pointStart to produce a modified x value.

The line cap used for line ends and line joins on the graph.

Polar charts only. Whether to connect the ends of a line series plot across the extremes.

Set the point threshold for when a series should enter boost mode. Setting it to e.g. 2000 will cause the series to enter boost mode when there are 2000 or more points in the series. To disable boosting on the series, set the boostThreshold to 0. Setting it to 1 will force boosting. Note that the cropThreshold also affects this setting. When zooming in on a series that has fewer points than the cropThreshold, all points are rendered although outside the visible plot area, and the boostThreshold won’t take effect.

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.

Add a point to the series after render time. The point can be added at the end, or by giving it an X value, to the start or in the middle of the series.

Add a point to the series after render time. The point can be added at the end, or by giving it an X value, to the start or in the middle of the series.

Add a point to the series after render time. The point can be added at the end, or by giving it an X value, to the start or in the middle of the series.

Add a point to the series after render time. The point can be added at the end, or by giving it an X value, to the start or in the middle of the series.

Animate in the series. Called internally twice. First with the init parameter set to true, which sets up the initial state of the animation. Then when ready, it is called with the init parameter undefined, in order to perform the actual animation. After the second run, the function is removed.

Draw the graph. Called internally when rendering line-like series types. The first time it generates the series.graph item and optionally other series-wide items like series.area for area charts. On subsequent calls these items are updated with new positions and attributes.

Draw the markers for line-like series types, and columns or other graphical representation for Highcharts.Point objects for other series types. The resulting element is typically stored as Highcharts.Point.graphic, and is created on the first call and updated and moved on subsequent calls.

Hide the series if visible. If the chart.ignoreHiddenSeries option is true, the chart is redrawn without this series.

Runs on mouse out of the series graphical items.

Runs on mouse over the series graphical items.

Remove a series and optionally redraw the chart.

Remove a series and optionally redraw the chart.

Remove a series and optionally redraw the chart.

Remove a series and optionally redraw the chart.

Remove a point from the series. Unlike the Highcharts.Point#remove method, this can also be done on a point that is not instanciated because it is outside the view or subject to Highstock data grouping.

Remove a point from the series. Unlike the Highcharts.Point#remove method, this can also be done on a point that is not instanciated because it is outside the view or subject to Highstock data grouping.

Remove a point from the series. Unlike the Highcharts.Point#remove method, this can also be done on a point that is not instanciated because it is outside the view or subject to Highstock data grouping.

Render the graph and markers. Called internally when first rendering and later when redrawing the chart. This function can be extended in plugins, but normally shouldn’t be called directly.

Select or unselect the series. This means its selected property is set, the checkbox in the legend is toggled and when selected, the series is returned by the Highcharts.Chart#getSelectedSeries function.

Select or unselect the series. This means its selected property is set, the checkbox in the legend is toggled and when selected, the series is returned by the Highcharts.Chart#getSelectedSeries function.

Apply a new set of data to the series and optionally redraw it. The new data array is passed by reference (except in case of updatePoints), and may later be mutated when updating the chart data.

Apply a new set of data to the series and optionally redraw it. The new data array is passed by reference (except in case of updatePoints), and may later be mutated when updating the chart data.

Apply a new set of data to the series and optionally redraw it. The new data array is passed by reference (except in case of updatePoints), and may later be mutated when updating the chart data.

Apply a new set of data to the series and optionally redraw it. The new data array is passed by reference (except in case of updatePoints), and may later be mutated when updating the chart data.

Set the series options by merging from the options tree. Called internally on initiating and updating series. This function will not redraw the series. For API usage, use Highcharts.Series#update.

Set the state of the series. Called internally on mouse interaction operations, but it can also be called directly to visually highlight a series.

Set the state of the series. Called internally on mouse interaction operations, but it can also be called directly to visually highlight a series.

Show or hide the series.

Show or hide the series.

Show or hide the series.

Show the series if hidden.

Sonify a series.

Translate data points from raw data values to chart specific positioning data needed later in the drawPoints and drawGraph functions. This function can be overridden in plugins and custom series type implementations.

Update the series with a new set of options. For a clean and precise handling of new options, all methods and elements from the series are removed, and it is initiated from scratch. Therefore, this method is more performance expensive than some other utility methods like Highcharts.Series#setData or Highcharts.Series#setVisible.

Update the series with a new set of options. For a clean and precise handling of new options, all methods and elements from the series are removed, and it is initiated from scratch. Therefore, this method is more performance expensive than some other utility methods like Highcharts.Series#setData or Highcharts.Series#setVisible.