Skip to main content

SeriesBasedChartOptions

Base options for a series based chart

Extends​

Extended by​

Type Parameters​

T​

T extends ChartSeriesOptions

Properties​

colorGenerator?​

optional colorGenerator: ColorGenerator

Optional function to call in order to establish the color to be used for each series

Inherited from​

BaseChartOptions.colorGenerator

data?​

optional data: ObjectData[]

Optional data to load into the chart.

Inherited from​

BaseChartOptions.data

dataSource?​

optional dataSource: DataSource

Optional data source (of type DataSource, meaning both VisuallyJsModel and Selection are supported) from which to retrieve data to load into the chart.

Inherited from​

BaseChartOptions.dataSource

dataSourceFilter?​

optional dataSourceFilter: ChartModelFilter

When you provide dataSource, you can also provide a filter which accepts or rejects specific nodes/groups in the data source.

Inherited from​

BaseChartOptions.dataSourceFilter

defaultColor?​

optional defaultColor: string

Optional color to use for every series. Overrides any colorGenerator.

Inherited from​

BaseChartOptions.defaultColor

emptyMessage?​

optional emptyMessage: string

Message to display when the chart has no data. Defaults to "No data".

Inherited from​

BaseChartOptions.emptyMessage

grouped?​

optional grouped: boolean

If true, the data will be grouped, if the chart type supports it (eg Bar/Column).

groupField?​

optional groupField: string

The name of the field that identifies which group a data point belongs to. Defaults to group.

height?​

optional height: number

Height for the chart. If omitted, height is computed from the width of the chart's container

Inherited from​

BaseChartOptions.height

legend?​

optional legend: boolean | LegendSpec

Either a boolean true/false, indicating the legend should be shown/hidden, or a spec for a legend.

Inherited from​

BaseChartOptions.legend

resizeObserver?​

optional resizeObserver: boolean

Defaults to true, meaning the chart will redraw when its container element resizes.

Inherited from​

BaseChartOptions.resizeObserver

series​

series: T[]

Definition of the chart series' to display. You can display multiple series on a chart.

style?​

optional style: ChartStyleOptions

Styles for legend and grid.

Inherited from​

BaseChartOptions.style

subtitle?​

optional subtitle: SubtitleSpec

Subtitle for the chart.

Inherited from​

BaseChartOptions.subtitle

title?​

optional title: ChartTitleSpec

Title for the chart.

Inherited from​

BaseChartOptions.title

titlePadding?​

optional titlePadding: number

Padding to leave underneath the title

Inherited from​

BaseChartOptions.titlePadding

tooltip?​

optional tooltip: TooltipOptions

Options for a tooltip for the chart.

Inherited from​

BaseChartOptions.tooltip

url?​

optional url: string

Optional URL from which to retrieve data to load into the chart

Inherited from​

BaseChartOptions.url

width?​

optional width: number

Width for the chart. If omitted, width is computed from the width of the chart's container

Inherited from​

BaseChartOptions.width

zoom?​

optional zoom: object

Optional zoom configuration.

enabled?​

optional enabled: boolean

Whether or not zoom is enabled.

initialValue?​

optional initialValue: number

Initial zoom value. Defaults to 1.

range?​

optional range: [number, number]

Zoom range to support. Defaults to [0.05, 3]

Inherited from​

BaseChartOptions.zoom