Skip to main content

BaseChartOptions

Base options for charts.

Extended by​

Properties​

colorGenerator?​

optional colorGenerator: ColorGenerator

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

data?​

optional data: ObjectData[]

Optional data to load into the chart.

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.

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.

defaultColor?​

optional defaultColor: string

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

emptyMessage?​

optional emptyMessage: string

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

height?​

optional height: number

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

legend?​

optional legend: boolean | LegendSpec

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

resizeObserver?​

optional resizeObserver: boolean

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

style?​

optional style: ChartStyleOptions

Styles for legend and grid.

subtitle?​

optional subtitle: SubtitleSpec

Subtitle for the chart.

title?​

optional title: ChartTitleSpec

Title for the chart.

titlePadding?​

optional titlePadding: number

Padding to leave underneath the title

tooltip?​

optional tooltip: TooltipOptions

Options for a tooltip for the chart.

url?​

optional url: string

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

width?​

optional width: number

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

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]