Hierarchy

  • Series

Properties

areaColor: string

The area color of the series. Only applies if series type is area or lineWithArea.

areaSvgClassName: string

The CSS style class to apply if series type is area or lineWithArea. See the Help documentation for more information.

areaSvgStyle: object

The inline style to apply if series type is area or lineWithArea. See the Help documentation for more information.

assignedToY2: string

Defines whether the series is associated with the y2 axis. Only applies to Cartesian bar, line, area, and combo charts.

borderColor: string

The border color of the series.

borderWidth: number

The border width of the series.

boxPlot: SeriesBoxPlot

An object containing the style properties of the box plot series.

categories: string[]

An optional array of category strings corresponding to this series. This allows highlighting and filtering of a series through interactions with legend sections. If not defined, the series id is used.

color: string

The color of the series. The chart legend item will inherit this color value.

displayInLegend: string

Defines whether the series should be shown in the legend. When set to 'auto', the series will not be displayed in the legend if it has null data or if it is a stock, funnel, or pyramid series.

drilling: string

Whether drilling is enabled on the series item. See the Help documentation for more information.

id: string | number

The id of the series. Defaults to the name or the series index if not specified.

items: object[]

An array of values or an array of objects that defines the data items for the series.

lineStyle: string

The line style of the data line. Only applies to line, lineWithArea, scatter, and bubble series.

lineType: string

The line type of the data line or area. Only applies to line, area, scatter, and bubble series. See the Help documentation for more information.

lineWidth: number

The width of the data line. Only applies to line, lineWithArea, scatter, and bubble series.

markerColor: string

The color of the data markers, if different from the series color.

markerDisplayed: string

Defines whether the data marker is displayed. Only applies to line, area, scatter, and bubble series. See the Help documentation for more information.

markerShape: string

The shape of the data markers. In addition to the built-in shapes, it may also take SVG path commands to specify a custom shape. See the Help documentation for more information.

markerSize: number

The size of the data markers.

markerSvgClassName: string

The CSS style class to apply to the data markers. See the Help documentation for more information.

markerSvgStyle: object

The inline style to apply to the data markers. See the Help documentation for more information.

name: string

The name of the series, displayed in the legend and tooltips.

pattern: string

The pattern used to fill the series. A solid fill is used by default, unless the seriesEffect is 'pattern'.

pieSliceExplode: number

A number from 0 to 1 indicating the amount to explode the pie slice. Only applies to pie charts.

shortDesc: string

The description of this series. This is used for accessibility and for customizing the tooltip text on the corresponding legend item for the series.

source: string

The URI of the custom image. If specified, it takes precedence over shape.

sourceHover: string

The optional URI for the hover state. If not specified, the source image will be used.

sourceHoverSelected: string

The optional URI for the hover selected state. If not specified, the source image will be used.

sourceSelected: string

The optional URI for the selected state. If not specified, the source image will be used.

stackCategory: string

In stacked charts, groups series together for stacking. All series without a stackCategory will be assigned to the same stack.

svgClassName: string

The CSS style class to apply to the series. For series of type lineWithArea, this style will only be applied to the line if areaSvgClassName is also specified. See the Help documentation for more information.

svgStyle: object

The inline style to apply to the series. For series of type lineWithArea, this style will only be applied to the line if areaSvgStyle is also specified. See the Help documentation for more information.

type: string

The type of data objects to display for this series. Only applies to combo and stock charts.

Generated using TypeDoc