- Interface: Defaults
- Hierarchy
- Properties
- Methods
Interface: Defaults
Hierarchy
Properties
animation
• animation: false
| AnimationSpec
<keyof ChartTypeRegistry
> & { onComplete?
: (event
: AnimationEvent
) => void
; onProgress?
: (event
: AnimationEvent
) => void
}
Inherited from
Defined in
index.esm.d.ts:1588 (opens new window)
animations
• animations: AnimationsSpec
<keyof ChartTypeRegistry
>
Inherited from
Defined in
index.esm.d.ts:1598 (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
Inherited from
Defined in
index.esm.d.ts:1441 (opens new window)
backgroundColor
• backgroundColor: Color
base background color
see
Defaults.backgroundColor
Inherited from
CoreChartOptions.backgroundColor
Defined in
index.esm.d.ts:1410 (opens new window)
borderColor
• borderColor: Color
base border color
see
Defaults.borderColor
Inherited from
Defined in
index.esm.d.ts:1415 (opens new window)
color
• color: Color
base color
see
Defaults.color
Inherited from
Defined in
index.esm.d.ts:1405 (opens new window)
datasets
• datasets: Object
Type declaration
Name | Type |
---|---|
bar | |
bubble | |
doughnut | |
line | |
pie | |
polarArea | |
radar | |
scatter |
Inherited from
Defined in
index.esm.d.ts:1391 (opens new window)
devicePixelRatio
• devicePixelRatio: number
Override the window’s default devicePixelRatio.
default
window.devicePixelRatio
Inherited from
CoreChartOptions.devicePixelRatio
Defined in
index.esm.d.ts:1458 (opens new window)
elements
• elements: ElementOptionsByType
<keyof ChartTypeRegistry
>
Inherited from
ElementChartOptions.elements
Defined in
index.esm.d.ts:1959 (opens new window)
events
• events: ("mousemove"
| "mouseout"
| "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’]
Inherited from
Defined in
index.esm.d.ts:1468 (opens new window)
font
• font: FontSpec
base font
see
Defaults.font
Inherited from
Defined in
index.esm.d.ts:1420 (opens new window)
hover
• hover: CoreInteractionOptions
Inherited from
Defined in
index.esm.d.ts:1462 (opens new window)
indexAxis
• indexAxis: "x"
| "y"
The base axis of the chart. ‘x’ for vertical charts and ‘y’ for horizontal charts.
default
‘x’
Inherited from
Defined in
index.esm.d.ts:1399 (opens new window)
interaction
• interaction: CoreInteractionOptions
Inherited from
Defined in
index.esm.d.ts:1460 (opens new window)
layout
• layout: Object
Type declaration
Name | Type |
---|---|
padding | Scriptable <number | ChartArea , ScriptableContext <keyof ChartTypeRegistry >> |
Inherited from
Defined in
index.esm.d.ts:1493 (opens new window)
locale
• locale: string
Locale used for number formatting (using Intl.NumberFormat
).
default
user’s browser setting
Inherited from
Defined in
index.esm.d.ts:1447 (opens new window)
maintainAspectRatio
• maintainAspectRatio: boolean
Maintain the original canvas aspect ratio (width / height) when resizing.
default
true
Inherited from
CoreChartOptions.maintainAspectRatio
Defined in
index.esm.d.ts:1430 (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
Defined in
index.esm.d.ts:55 (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
Defined in
index.esm.d.ts:46 (opens new window)
plugins
• plugins: PluginOptionsByType
<keyof ChartTypeRegistry
>
Inherited from
Defined in
index.esm.d.ts:2715 (opens new window)
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
Inherited from
Defined in
index.esm.d.ts:1435 (opens new window)
responsive
• responsive: boolean
Resizes the chart canvas when its container does (important note…).
default
true
Inherited from
Defined in
index.esm.d.ts:1425 (opens new window)
scale
• scale: ScaleOptionsByType
<keyof ScaleTypeRegistry
>
Defined in
index.esm.d.ts:638 (opens new window)
scales
• scales: Object
Type declaration
Name | Type |
---|---|
category | |
linear | |
logarithmic | |
radialLinear | |
time | |
timeseries |
Defined in
index.esm.d.ts:639 (opens new window)
transitions
• transitions: TransitionsSpec
<keyof ChartTypeRegistry
>
Inherited from
Defined in
index.esm.d.ts:1599 (opens new window)
Methods
describe
▸ describe(scope
, values
): AnyObject
Parameters
Name | Type |
---|---|
scope | string |
values | AnyObject |
Returns
AnyObject
Defined in
index.esm.d.ts:647 (opens new window)
get
▸ get(scope
): AnyObject
Parameters
Name | Type |
---|---|
scope | string |
Returns
AnyObject
Defined in
index.esm.d.ts:645 (opens new window)
onClick
▸ onClick(event
, 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
Name | Type |
---|---|
event | ChartEvent |
elements | ActiveElement [] |
chart | Chart <keyof ChartTypeRegistry , (number | ScatterDataPoint | BubbleDataPoint )[], unknown > |
Returns
void
Inherited from
Defined in
index.esm.d.ts:1491 (opens new window)
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
Name | Type |
---|---|
event | ChartEvent |
elements | ActiveElement [] |
chart | Chart <keyof ChartTypeRegistry , (number | ScatterDataPoint | BubbleDataPoint )[], unknown > |
Returns
void
Inherited from
Defined in
index.esm.d.ts:1486 (opens new window)
onResize
▸ onResize(chart
, size
): void
Called when a resize occurs. Gets passed two arguments: the chart instance and the new size.
Parameters
Name | Type |
---|---|
chart | Chart <keyof ChartTypeRegistry , (number | ScatterDataPoint | BubbleDataPoint )[], unknown > |
size | Object |
size.height | number |
size.width | number |
Returns
void
Inherited from
Defined in
index.esm.d.ts:1452 (opens new window)
override
▸ override(scope
, values
): AnyObject
Parameters
Name | Type |
---|---|
scope | string |
values | AnyObject |
Returns
AnyObject
Defined in
index.esm.d.ts:648 (opens new window)
route
▸ route(scope
, name
, targetScope
, targetName
): void
Routes the named defaults to fallback to another scope/name. This routing is useful when those target values, like defaults.color, are changed runtime. If the values would be copied, the runtime change would not take effect. By routing, the fallback is evaluated at each access, so its always up to date.
Example:
defaults.route(‘elements.arc’, ‘backgroundColor’, ‘’, ‘color’)
- reads the backgroundColor from defaults.color when undefined locally
Parameters
Name | Type | Description |
---|---|---|
scope | string | Scope this route applies to. |
name | string | Property name that should be routed to different namespace when not defined here. |
targetScope | string | The namespace where those properties should be routed to. Empty string (‘’) is the root of defaults. |
targetName | string | The target name in the target scope the property should be routed to. |
Returns
void
Defined in
index.esm.d.ts:667 (opens new window)
set
▸ set(values
): AnyObject
Parameters
Name | Type |
---|---|
values | AnyObject |
Returns
AnyObject
Defined in
index.esm.d.ts:643 (opens new window)
▸ set(scope
, values
): AnyObject
Parameters
Name | Type |
---|---|
scope | string |
values | AnyObject |
Returns
AnyObject