Skip to main content

RecordBasedSeriesOptions

Options for a RecordBasedSeries.

Extends​

Properties​

color?​

optional color: string

Color to use for the series. This is optional and if not provided the chart will use a color from its installed ColorGenerator.

Inherited from​

ChartSeriesOptions.color

id?​

optional id: string

The id of the series.

Inherited from​

ChartSeriesOptions.id

label?​

optional label: string

Label for the series. Optional.

Inherited from​

ChartSeriesOptions.label

marker?​

optional marker: string

Optional template to use for markers. This should be a string in VisuallyJs's internal template format, with namespaced SVG elements.

Inherited from​

ChartSeriesOptions.marker

markerSize?​

optional markerSize: number

Size (in pixels) to use for data points. Defaults to 10 pixels. For circular markers this equates to the diameter; for square/cross this is width/height

Inherited from​

ChartSeriesOptions.markerSize

markerType?​

optional markerType: "square" | "circle" | "cross"

Type of marker to draw. Defaults to "circle".

Inherited from​

ChartSeriesOptions.markerType

maxValueField?​

optional maxValueField: string

Name of the field containing maximum values, when the series is used in a range plot. Defaults to "maxValue".

minValueField?​

optional minValueField: string

Name of the field containing minimum values, when the series is used in a range plot. Defaults to "minValue".

resolveMarker?​

optional resolveMarker: MarkerResolutionFunction

Optional function to resolve a marker SVG string for each data point.

Inherited from​

ChartSeriesOptions.resolveMarker

type?​

optional type: string

Defines the series type.

Inherited from​

ChartSeriesOptions.type

valueField?​

optional valueField: string

Name of the field containing values. Defaults to "value".