Interface: CoreChartOptions<TType>

Type parameters

Hierarchy

• ParsingOptions

• AnimationOptions<TType>

  ↳ CoreChartOptions

  ↳↳ Defaults

Properties

animation

• animation: false | AnimationSpec<TType> & { onComplete?: (event: AnimationEvent) => void ; onProgress?: (event: AnimationEvent) => void }

Inherited from: AnimationOptions.animation

Defined in: index.esm.d.ts:1533 (opens new window)

animations

• animations: AnimationsSpec<TType>

Inherited from: AnimationOptions.animations

Defined in: index.esm.d.ts:1543 (opens new window)

aspectRatio

• aspectRatio: number

Canvas aspect ratio (i.e. width / height, a value of 1 representing a square canvas). Note that this option is ignored if the height is explicitly defined either as attribute or via the style.

default 2

Defined in: index.esm.d.ts:1399 (opens new window)

backgroundColor

• backgroundColor: Color

base background color

see Defaults.backgroundColor

Defined in: index.esm.d.ts:1373 (opens new window)

borderColor

• borderColor: Color

base border color

see Defaults.borderColor

Defined in: index.esm.d.ts:1378 (opens new window)

color

• color: Color

base color

see Defaults.color

Defined in: index.esm.d.ts:1368 (opens new window)

datasets

• datasets: object

Type declaration

Defined in: index.esm.d.ts:1354 (opens new window)

devicePixelRatio

• devicePixelRatio: number

Override the window’s default devicePixelRatio.

default window.devicePixelRatio

Defined in: index.esm.d.ts:1416 (opens new window)

events

• events: ("mousemove" | "mouseout" | "click" | "touchstart" | "touchmove")[]

The events option defines the browser events that the chart should listen to for tooltips and hovering.

default [‘mousemove’, ‘mouseout’, ‘click’, ‘touchstart’, ‘touchmove’]

Defined in: index.esm.d.ts:1426 (opens new window)

font

• font: FontSpec

base font

see Defaults.font

Defined in: index.esm.d.ts:1383 (opens new window)

hover

• hover: CoreInteractionOptions

Defined in: index.esm.d.ts:1420 (opens new window)

indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. ‘x’ for vertical charts and ‘y’ for horizontal charts.

default ‘x’

Defined in: index.esm.d.ts:1362 (opens new window)

interaction

• interaction: CoreInteractionOptions

Defined in: index.esm.d.ts:1418 (opens new window)

layout

• layout: object

Type declaration

Defined in: index.esm.d.ts:1438 (opens new window)

locale

• locale: string

Locale used for number formatting (using Intl.NumberFormat).

default user’s browser setting

Defined in: index.esm.d.ts:1405 (opens new window)

maintainAspectRatio

• maintainAspectRatio: boolean

Maintain the original canvas aspect ratio (width / height) when resizing.

default true

Defined in: index.esm.d.ts:1393 (opens new window)

normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

Inherited from: ParsingOptions.normalized

Defined in: index.esm.d.ts:52 (opens new window)

parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

Inherited from: ParsingOptions.parsing

Defined in: index.esm.d.ts:43 (opens new window)

responsive

• responsive: boolean

Resizes the chart canvas when its container does (important note…).

default true

Defined in: index.esm.d.ts:1388 (opens new window)

transitions

• transitions: TransitionsSpec<TType>

Inherited from: AnimationOptions.transitions

Defined in: index.esm.d.ts:1544 (opens new window)

Methods

onClick

▸ onClick(event: ChartEvent, elements: ActiveElement[], chart: Chart<"bar" | "line" | "scatter" | "bubble" | "pie" | "doughnut" | "polarArea" | "radar", (number | ScatterDataPoint | BubbleDataPoint)[], unknown>): void

Called if the event is of type ‘mouseup’ or ‘click’. Passed the event, an array of active elements, and the chart.

Parameters

Returns: void

Defined in: index.esm.d.ts:1436 (opens new window)

onHover

▸ onHover(event: ChartEvent, elements: ActiveElement[], chart: Chart<"bar" | "line" | "scatter" | "bubble" | "pie" | "doughnut" | "polarArea" | "radar", (number | ScatterDataPoint | BubbleDataPoint)[], unknown>): void

Called when any of the events fire. Passed the event, an array of active elements (bars, points, etc), and the chart.

Parameters

Returns: void

Defined in: index.esm.d.ts:1431 (opens new window)

onResize

▸ onResize(chart: Chart<"bar" | "line" | "scatter" | "bubble" | "pie" | "doughnut" | "polarArea" | "radar", (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, size: { height: number ; width: number }): void

Called when a resize occurs. Gets passed two arguments: the chart instance and the new size.

Parameters

Returns: void

Defined in: index.esm.d.ts:1410 (opens new window)