Skip to main content

XYChartOptions

Base interface for XYChart options.

Extends​

Extended by​

Type Parameters​

O​

O extends ChartSeriesOptions

Properties​

axisLineSize?​

optional axisLineSize: number

The width to use if showing a line marking value/category axes. By default, axis lines are not painted.

Inherited from​

XYChartBaseOptions.axisLineSize

colorGenerator?​

optional colorGenerator: ColorGenerator

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

Inherited from​

XYChartBaseOptions.colorGenerator

cornerRadius?​

optional cornerRadius: number

When rounding bar/column corners, use this radius. Defaults to 5 pixels.

Inherited from​

XYChartBaseOptions.cornerRadius

data?​

optional data: ObjectData[]

Optional data to load into the chart.

Inherited from​

XYChartBaseOptions.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​

XYChartBaseOptions.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​

XYChartBaseOptions.dataSourceFilter

defaultColor?​

optional defaultColor: string

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

Inherited from​

XYChartBaseOptions.defaultColor

emptyMessage?​

optional emptyMessage: string

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

Inherited from​

XYChartBaseOptions.emptyMessage

grouped?​

optional grouped: boolean

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

Inherited from​

XYChartBaseOptions.grouped

groupField?​

optional groupField: string

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

Inherited from​

XYChartBaseOptions.groupField

height?​

optional height: number

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

Inherited from​

XYChartBaseOptions.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​

XYChartBaseOptions.legend

legendPadding?​

optional legendPadding: number

When the legend is not floating, this number defines how much whitespace to leave around it.

Inherited from​

XYChartBaseOptions.legendPadding

maxLabelSize?​

optional maxLabelSize: number

The maximum size a category label can be as a ratio of the chart's overall size. Category labels are rotated to 45 degrees automatically when they start to overlap each other, but if the labels are long strings then there is a chance they'll use up too much of the available chart space. This value (whose default is 0.2), specifies a hard limit for label size, to avoid that situation. In a chart whose category axis is the X axis, this is applied relative to the height of the chart, and in a chart whose category axis is the Y axis, it's applied relative to the width.

Inherited from​

XYChartBaseOptions.maxLabelSize

resizeObserver?​

optional resizeObserver: boolean

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

Inherited from​

XYChartBaseOptions.resizeObserver

roundCorners?​

optional roundCorners: boolean

Whether or not to round the corners of bars/columns. Defaults to true

Inherited from​

XYChartBaseOptions.roundCorners

series​

series: O[]

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

Inherited from​

XYChartBaseOptions.series

style?​

optional style: ChartStyleOptions

Styles for legend and grid.

Inherited from​

XYChartBaseOptions.style

subtitle?​

optional subtitle: SubtitleSpec

Subtitle for the chart.

Inherited from​

XYChartBaseOptions.subtitle

title?​

optional title: ChartTitleSpec

Title for the chart.

Inherited from​

XYChartBaseOptions.title

titlePadding?​

optional titlePadding: number

Padding to leave underneath the title

Inherited from​

XYChartBaseOptions.titlePadding

tooltip?​

optional tooltip: TooltipOptions

Options for the info tooltip.

Inherited from​

XYChartBaseOptions.tooltip

url?​

optional url: string

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

Inherited from​

XYChartBaseOptions.url

width?​

optional width: number

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

Inherited from​

XYChartBaseOptions.width

yAxisPadding?​

optional yAxisPadding: number

How much padding to leave between the y axes decoration and the chart content area.

Inherited from​

XYChartBaseOptions.yAxisPadding

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​

XYChartBaseOptions.zoom