Interface: CoreChartOptions<TType>
• animation: false
| AnimationSpec<TType
> & { onComplete?
: (event
: ) => void
; onProgress?
: (event
: AnimationEvent) => void
}
Inherited from
AnimationOptions.animation
Defined in
animations
• animations: <TType
>
Inherited from
AnimationOptions.animations
Defined in
index.esm.d.ts:1609 (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
backgroundColor
• backgroundColor: <Color, <TType
>>
base background color
see
Defaults.backgroundColor
Defined in
borderColor
• borderColor: <Color, <TType
>>
base border color
see
Defaults.borderColor
Defined in
color
• color: <Color, <TType
>>
base color
see
Defaults.color
Defined in
datasets
• datasets: Object
Type declaration
Defined in
devicePixelRatio
• devicePixelRatio: number
default
window.devicePixelRatio
Defined in
index.esm.d.ts:1468 (opens new window)
• events: ("mousemove"
| | "click"
| "touchstart"
| "touchmove"
| "touchend"
| "pointerenter"
| "pointerdown"
| "pointermove"
| "pointerup"
| "pointerleave"
| "pointerout"
)[]
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:1478 (opens new window)
font
• font: Partial
<FontSpec>
base font
see
Defaults.font
Defined in
index.esm.d.ts:1430 (opens new window)
hover
• hover: CoreInteractionOptions
Defined in
index.esm.d.ts:1472 (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
interaction
• interaction:
Defined in
layout
• layout: Partial
<Object
>
Defined in
index.esm.d.ts:1503 (opens new window)
locale
• locale: string
Locale used for number formatting (using Intl.NumberFormat
).
default
user’s browser setting
Defined in
maintainAspectRatio
• maintainAspectRatio: boolean
Maintain the original canvas aspect ratio (width / height) when resizing.
default
true
Defined in
index.esm.d.ts:1440 (opens new window)
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
Defined in
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
Defined in
resizeDelay
• resizeDelay: number
Delay the resize update by give amount of milliseconds. This can ease the resize process by debouncing update of the elements.
default
0
Defined in
index.esm.d.ts:1445 (opens new window)
responsive
• responsive: boolean
Resizes the chart canvas when its container does (important note…).
default
true
Defined in
transitions
• transitions: <TType
>
Inherited from
AnimationOptions.transitions
Defined in
index.esm.d.ts:1610 (opens new window)
onClick
▸ onClick(, elements
, chart
): 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
onHover
▸ onHover(event
, elements
, chart
): 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:1496 (opens new window)
onResize
▸ onResize(chart
, size
): void
Called when a resize occurs. Gets passed two arguments: the chart instance and the new size.