Class SeriesDescriptor

A descriptor used to define a chart series when creating a figure from JS.

Hierarchy

  • SeriesDescriptor

Constructors

constructor

Properties

dataSources gradientVisible? lineColor? linesVisible? name? plotStyle pointLabelFormat? shape? shapeColor? shapeLabel? shapeSize? shapesVisible? xToolTipPattern? yToolTipPattern?

Constructors

constructor

Properties

dataSources

dataSources: SourceDescriptor[]

The data sources for this series.

Optional gradientVisible

gradientVisible?: boolean

Whether the series uses gradient rendering.

Optional lineColor

lineColor?: string

The line color.

Optional linesVisible

linesVisible?: boolean

Whether lines are visible.

Optional name

name?: string

plotStyle

plotStyle: string | number

Optional pointLabelFormat

pointLabelFormat?: string

A format string used to render point labels.

This value is passed through to the underlying plotting implementation. The interpretation of the format string is defined by the plotting implementation.

Optional shape

shape?: string

The shape name.

Optional shapeColor

shapeColor?: string

The shape color.

Optional shapeLabel

shapeLabel?: string

The shape label.

Optional shapeSize

shapeSize?: number

The shape size.

Optional shapesVisible

shapesVisible?: boolean

Whether shapes are visible.

Optional xToolTipPattern

xToolTipPattern?: string

A format string used to render X values in tooltips.

This value is passed through to the underlying plotting implementation. The interpretation of the format string is defined by the plotting implementation.

Optional yToolTipPattern

yToolTipPattern?: string

A format string used to render Y values in tooltips.

This value is passed through to the underlying plotting implementation. The interpretation of the format string is defined by the plotting implementation.

Settings

Member Visibility

Theme

On This Page