Class: Chart<TType, TData, TLabel>

Type parameters

Name	Type
`TType`	extends `“bar”` \| `“line”` \| `“scatter”` \| `“bubble”` \| `“pie”` \| `“doughnut”` \| `“polarArea”` \| “radar”````”bar” \| `“line”` \| `“scatter”` \| `“bubble”` \| `“pie”` \| `“doughnut”` \| `“polarArea”` \| `“radar”`
`TData`	[`TType`][`“defaultDataPoint”`][]
`TLabel`	`unknown`

Parameters

Name	Type
`item`
`config`	`ChartConfiguration`<`TType`, `TData`, `TLabel`>

Defined in

index.esm.d.ts:468 (opens new window)

aspectRatio

• Readonly aspectRatio: number

Defined in

attached

• Readonly attached: boolean

Defined in

index.esm.d.ts:465 (opens new window)

boxes

• Readonly boxes: LayoutItem[]

Defined in

index.esm.d.ts:461 (opens new window)

canvas

• Readonly canvas: HTMLCanvasElement

Defined in

chartArea

• Readonly chartArea:

Defined in

config

• Readonly config: <TType, TData, TLabel>

Defined in

ctx

• Readonly ctx: CanvasRenderingContext2D

Defined in

index.esm.d.ts:456 (opens new window)

currentDevicePixelRatio

• Readonly currentDevicePixelRatio: number

Defined in

data

• data: <TType, TData, TLabel>

Defined in

height

• Readonly height: number

Defined in

index.esm.d.ts:459 (opens new window)

id

• Readonly id: string

Defined in

options

• options: DeepPartial<<TType> & ElementChartOptions<TType> & <TType> & DatasetChartOptions<TType> & <TType> & ChartTypeRegistry[TType]["chartOptions"]>

Defined in

index.esm.d.ts:468 (opens new window)

platform

• Readonly platform: BasePlatform

Defined in

index.esm.d.ts:453 (opens new window)

scales

• Readonly scales: Object

Index signature

▪ [key: string]:

Defined in

width

• Readonly width: number

Defined in

index.esm.d.ts:458 (opens new window)

defaults

▪ Static Readonly defaults: Defaults

Defined in

index.esm.d.ts:507 (opens new window)

▪ Static Readonly instances: Object

Index signature

▪ [key: string]: Chart

Defined in

index.esm.d.ts:510 (opens new window)

overrides

▪ Static Readonly overrides: Overrides

Defined in

index.esm.d.ts:508 (opens new window)

registry

▪ Static Readonly registry: Registry

Defined in

index.esm.d.ts:511 (opens new window)

version

▪ Static Readonly version: string

Defined in

bindEvents

▸ bindEvents(): void

Returns

Defined in

buildOrUpdateControllers

▸ buildOrUpdateControllers(): void

Returns

void

Defined in

buildOrUpdateScales

▸ buildOrUpdateScales(): void

Returns

void

Defined in

clear

▸ clear(): <TType, TData, TLabel>

Returns

<TType, TData, TLabel>

Defined in

destroy

▸ destroy(): void

Returns

void

Defined in

draw

▸ draw(): void

Returns

void

Defined in

ensureScalesHaveIDs

▸ ensureScalesHaveIDs(): void

Returns

void

Defined in

getActiveElements

▸ getActiveElements(): []

Returns

[]

Defined in

getDataVisibility

▸ getDataVisibility(index): boolean

Parameters

Name	Type
`index`	`number`

Returns

boolean

Defined in

index.esm.d.ts:492 (opens new window)

getDatasetMeta

▸ getDatasetMeta(datasetIndex): ChartMeta<<Object, Object>, Element<Object, Object>>

Parameters

Name	Type
`datasetIndex`	`number`

Returns

<Element<Object, Object>, <Object, Object>>

Defined in

getElementsAtEventForMode

▸ getElementsAtEventForMode(e, mode, options, useFinalPosition): []

Parameters

Name	Type
`e`	`Event`
`mode`	`string`
`options`
`useFinalPosition`	`boolean`

Returns

[]

Defined in

getSortedVisibleDatasetMetas

▸ getSortedVisibleDatasetMetas(): <Element<Object, Object>, <Object, Object>>[]

Returns

<Element<Object, Object>, <Object, Object>>[]

Defined in

getVisibleDatasetCount

▸ getVisibleDatasetCount(): number

Returns

number

Defined in

▸ hide(datasetIndex): void

Parameters

Returns

void

Defined in

isDatasetVisible

▸ isDatasetVisible(datasetIndex): boolean

Parameters

Name	Type
`datasetIndex`	`number`

Returns

boolean

Defined in

index.esm.d.ts:489 (opens new window)

notifyPlugins

▸ notifyPlugins(hook, args?): boolean | void

Parameters

Name	Type
`hook`	`string`
`args?`	`Record`<`string`, `unknown`>

Returns

Defined in

render

▸ render(): void

Returns

void

Defined in

reset

▸ reset(): void

Returns

void

Defined in

resize

▸ resize(width?, height?): void

Parameters

Name	Type
`width?`	`number`
`height?`	`number`

Returns

void

Defined in

index.esm.d.ts:475 (opens new window)

setActiveElements

▸ setActiveElements(active):

Parameters

Name	Type
`active`	[]

Returns

void

Defined in

index.esm.d.ts:497 (opens new window)

setDatasetVisibility

▸ setDatasetVisibility(datasetIndex, visible): void

Parameters

Name	Type
`datasetIndex`	`number`
`visible`	`boolean`

Returns

void

Defined in

show

▸ show(datasetIndex): void

Parameters

Returns

void

Defined in

index.esm.d.ts:494 (opens new window)

stop

▸ stop(): Chart<TType, TData, TLabel>

Returns

Chart<TType, TData, TLabel>

Defined in

index.esm.d.ts:473 (opens new window)

toBase64Image

▸ toBase64Image(type?, quality?): string

Parameters

Name	Type
`type?`	`string`
`quality?`	`unknown`

Returns

string

Defined in

toggleDataVisibility

▸ toggleDataVisibility(index): void

Parameters

Name	Type
`index`	`number`

Returns

void

Defined in

index.esm.d.ts:491 (opens new window)

unbindEvents

▸ unbindEvents(): void

Returns

void

Defined in

index.esm.d.ts:502 (opens new window)

update

▸ update(mode?): void

Parameters

Name	Type
`mode?`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`

Returns

void

Defined in

updateHoverStyle

▸ updateHoverStyle(items, mode, enabled): void

Parameters

Name	Type
`items`	`Element`<`Object`, `Object`>
`mode`	`“dataset”`
`enabled`	`boolean`

Returns

void

Defined in

getChart

Parameters

Name	Type
`key`	`string` \| `HTMLCanvasElement` \| `CanvasRenderingContext2D`

Returns

Defined in

index.esm.d.ts:512 (opens new window)

register

▸ Static register(…items): void

Parameters

Returns

void

Defined in

▸ Static unregister(…items): void

Parameters

Name	Type
`…items`	[]

Returns

Defined in

index.esm.d.ts:514 (opens new window)