Class: Chart<TType, TData, TLabel>

Type parameters

Parameters

Returns: <TType, TData, TLabel>

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

aspectRatio

• Readonly aspectRatio: number

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

attached

• Readonly attached: boolean

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

boxes

• Readonly boxes: LayoutItem[]

Defined in:

canvas

• Readonly canvas: HTMLCanvasElement

Defined in:

chartArea

• Readonly chartArea:

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

config

• Readonly config: ChartConfiguration<TType, TData, TLabel>

Defined in:

ctx

• Readonly ctx: CanvasRenderingContext2D

Defined in:

currentDevicePixelRatio

• Readonly currentDevicePixelRatio: number

Defined in:

data

• data: <TType, TData, TLabel>

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

height

• Readonly height: number

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

id

• Readonly id: string

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

options

• options: DeepPartial<CoreChartOptions<TType> & <TType> & PluginChartOptions<TType> & <TType> & ScaleChartOptions<TType> & [TType]["chartOptions"]>

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

platform

• Readonly platform: BasePlatform

Defined in:

scales

• Readonly scales: object

Type declaration

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

width

• Readonly width: number

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

defaults

▪ Static Readonly defaults: Defaults

Defined in:

▪ Static Readonly instances: object

Type declaration

Defined in:

overrides

▪ Static overrides:

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

registry

▪ Static Readonly registry: Registry

Defined in:

version

▪ Static Readonly version: string

Defined in:

bindEvents

▸ bindEvents(): void

Returns: void

buildOrUpdateControllers

▸ buildOrUpdateControllers(): void

Returns: void

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

buildOrUpdateScales

▸ buildOrUpdateScales(): void

Returns: void

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

clear

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

Returns: <TType, TData, TLabel>

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

destroy

▸ destroy(): void

Returns: void

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

draw

▸ draw(): void

Returns: void

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

ensureScalesHaveIDs

▸ ensureScalesHaveIDs(): void

Returns: void

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

getActiveElements

▸ getActiveElements(): ActiveElement[]

Returns: []

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

getDataVisibility

▸ getDataVisibility(index: number): boolean

Parameters

Returns: boolean

Defined in:

getDatasetMeta

▸ getDatasetMeta(datasetIndex: number): <Element<{}, {}>, <{}, {}>>

Parameters

Returns: <Element<{}, {}>, <{}, {}>>

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

getElementsAtEventForMode

▸ getElementsAtEventForMode(e: Event, mode: string, options: InteractionOptions, useFinalPosition: boolean): []

Parameters

Returns: InteractionItem[]

Defined in:

getSortedVisibleDatasetMetas

▸ getSortedVisibleDatasetMetas(): <Element<{}, {}>, <{}, {}>>[]

Returns: ChartMeta<<{}, {}>, Element<{}, {}>>[]

Defined in:

getVisibleDatasetCount

▸ getVisibleDatasetCount(): number

Returns: number

Defined in:

▸ hide(datasetIndex: number): void

Parameters

Returns: void

Defined in:

isDatasetVisible

▸ isDatasetVisible(datasetIndex: number): boolean

Parameters

Returns: boolean

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

notifyPlugins

▸ notifyPlugins(hook: string, args?: Record<string, unknown>): boolean | void

Parameters

Returns: boolean | void

render

▸ render(): void

Returns: void

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

reset

▸ reset(): void

Returns: void

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

resize

▸ resize(width?: number, height?: number): void

Parameters

Returns: void

Defined in:

setActiveElements

▸ setActiveElements(active: []): void

Parameters

Returns: void

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

setDatasetVisibility

▸ setDatasetVisibility(datasetIndex: number, visible: boolean): void

Parameters

Returns: void

Defined in:

show

▸ show(datasetIndex: number): void

Parameters

Returns: void

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

stop

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

Returns: <TType, TData, TLabel>

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

toBase64Image

▸ toBase64Image(type?: string, quality?: unknown): string

Parameters

Returns: string

Defined in:

toggleDataVisibility

▸ toggleDataVisibility(index: number): void

Parameters

Returns: void

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

unbindEvents

▸ unbindEvents(): void

Returns: void

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

update

▸ update(mode?: "resize" | "reset" | | "hide" | "show" | "normal" | "active"): void

Parameters

Returns: void

Defined in:

updateHoverStyle

▸ updateHoverStyle(items: <{}, {}>, mode: "dataset", enabled: boolean): void

Parameters

Returns: void

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

getChart

▸ Static getChart(key: string | HTMLCanvasElement | CanvasRenderingContext2D): Chart<"bar" | "line" | "scatter" | "bubble" | "pie" | "doughnut" | "polarArea" | "radar", (number | | BubbleDataPoint)[], unknown>

Parameters

Returns: Chart<"bar" | "line" | "scatter" | "bubble" | "pie" | "doughnut" | "polarArea" | "radar", (number | | BubbleDataPoint)[], unknown>

Defined in:

register

▸ Static register(…items: []): void

Parameters

Returns: void

Defined in:

▸ Static unregister(…items: ChartComponentLike[]): void

Parameters

Returns: void