# Class: Chart<TType, TData, TLabel>
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType = ChartType |
TData | DefaultDataPoint<TType> |
TLabel | unknown |
# Constructors
# constructor
• new Chart<TType, TData, TLabel>(item, config)
# Type parameters
| Name | Type |
|---|---|
TType | extends keyof ChartTypeRegistry = keyof ChartTypeRegistry |
TData | DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]> |
TLabel | unknown |
# Parameters
| Name | Type |
|---|---|
item | ChartItem |
config | ChartConfiguration<TType, TData, TLabel> | ChartConfigurationCustomTypesPerDataset<TType, TData, TLabel> |
# Defined in
types/index.d.ts:509 (opens new window)
# Properties
# aspectRatio
• Readonly aspectRatio: number
# Defined in
types/index.d.ts:496 (opens new window)
# attached
• Readonly attached: boolean
# Defined in
types/index.d.ts:501 (opens new window)
# boxes
• Readonly boxes: LayoutItem[]
# Defined in
types/index.d.ts:497 (opens new window)
# canvas
• Readonly canvas: HTMLCanvasElement
# Defined in
types/index.d.ts:491 (opens new window)
# chartArea
• Readonly chartArea: ChartArea
# Defined in
types/index.d.ts:499 (opens new window)
# config
• Readonly config: ChartConfiguration<TType, TData, TLabel> | ChartConfigurationCustomTypesPerDataset<TType, TData, TLabel>
# Defined in
types/index.d.ts:493 (opens new window)
# ctx
• Readonly ctx: CanvasRenderingContext2D
# Defined in
types/index.d.ts:492 (opens new window)
# currentDevicePixelRatio
• Readonly currentDevicePixelRatio: number
# Defined in
types/index.d.ts:498 (opens new window)
# data
• data: ChartData<TType, TData, TLabel>
# Defined in
types/index.d.ts:506 (opens new window)
# height
• Readonly height: number
# Defined in
types/index.d.ts:495 (opens new window)
# id
• Readonly id: string
# Defined in
types/index.d.ts:490 (opens new window)
# legend
• Optional Readonly legend: LegendElement<TType>
# Defined in
types/index.d.ts:503 (opens new window)
# options
• options: Exclude<DeepPartial<CoreChartOptions<TType> & ElementChartOptions<TType> & PluginChartOptions<TType> & DatasetChartOptions<TType> & ScaleChartOptions<TType> & ChartTypeRegistry[TType]["chartOptions"]>, _DeepPartialArray<unknown>>
# Defined in
types/index.d.ts:507 (opens new window)
# platform
• Readonly platform: BasePlatform
# Defined in
types/index.d.ts:489 (opens new window)
# scales
• Readonly scales: Object
# Index signature
▪ [key: string]: Scale
# Defined in
types/index.d.ts:500 (opens new window)
# tooltip
• Optional Readonly tooltip: TooltipModel<TType>
# Defined in
types/index.d.ts:504 (opens new window)
# width
• Readonly width: number
# Defined in
types/index.d.ts:494 (opens new window)
# defaults
▪ Static Readonly defaults: Defaults
# Defined in
types/index.d.ts:551 (opens new window)
# instances
▪ Static Readonly instances: Object
# Index signature
▪ [key: string]: Chart
# Defined in
types/index.d.ts:554 (opens new window)
# overrides
▪ Static Readonly overrides: Overrides
# Defined in
types/index.d.ts:552 (opens new window)
# registry
▪ Static Readonly registry: Registry
# Defined in
types/index.d.ts:555 (opens new window)
# version
▪ Static Readonly version: string
# Defined in
types/index.d.ts:553 (opens new window)
# Methods
# bindEvents
▸ bindEvents(): void
# Returns
void
# Defined in
types/index.d.ts:541 (opens new window)
# buildOrUpdateControllers
▸ buildOrUpdateControllers(): void
# Returns
void
# Defined in
types/index.d.ts:517 (opens new window)
# buildOrUpdateScales
▸ buildOrUpdateScales(): void
# Returns
void
# Defined in
types/index.d.ts:516 (opens new window)
# clear
▸ clear(): Chart<TType, TData, TLabel>
# Returns
Chart<TType, TData, TLabel>
# Defined in
types/index.d.ts:511 (opens new window)
# destroy
▸ destroy(): void
# Returns
void
# Defined in
types/index.d.ts:539 (opens new window)
# draw
▸ draw(): void
# Returns
void
# Defined in
types/index.d.ts:521 (opens new window)
# ensureScalesHaveIDs
▸ ensureScalesHaveIDs(): void
# Returns
void
# Defined in
types/index.d.ts:515 (opens new window)
# getActiveElements
▸ getActiveElements(): ActiveElement[]
# Returns
# Defined in
types/index.d.ts:536 (opens new window)
# getContext
▸ getContext(): Object
# Returns
Object
| Name | Type |
|---|---|
chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> |
type | string |
# Defined in
types/index.d.ts:549 (opens new window)
# getDataVisibility
▸ getDataVisibility(index): boolean
# Parameters
| Name | Type |
|---|---|
index | number |
# Returns
boolean
# Defined in
types/index.d.ts:532 (opens new window)
# getDatasetMeta
▸ getDatasetMeta(datasetIndex): ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
# Parameters
| Name | Type |
|---|---|
datasetIndex | number |
# Returns
ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
# Defined in
types/index.d.ts:527 (opens new window)
# getElementsAtEventForMode
▸ getElementsAtEventForMode(e, mode, options, useFinalPosition): InteractionItem[]
# Parameters
| Name | Type |
|---|---|
e | Event |
mode | string |
options | InteractionOptions |
useFinalPosition | boolean |
# Returns
# Defined in
types/index.d.ts:524 (opens new window)
# getSortedVisibleDatasetMetas
▸ getSortedVisibleDatasetMetas(): ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>[]
# Returns
ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>[]
# Defined in
types/index.d.ts:526 (opens new window)
# getVisibleDatasetCount
▸ getVisibleDatasetCount(): number
# Returns
number
# Defined in
types/index.d.ts:528 (opens new window)
# hide
▸ hide(datasetIndex, dataIndex?): void
# Parameters
| Name | Type |
|---|---|
datasetIndex | number |
dataIndex? | number |
# Returns
void
# Defined in
types/index.d.ts:533 (opens new window)
# isDatasetVisible
▸ isDatasetVisible(datasetIndex): boolean
# Parameters
| Name | Type |
|---|---|
datasetIndex | number |
# Returns
boolean
# Defined in
types/index.d.ts:529 (opens new window)
# isPluginEnabled
▸ isPluginEnabled(pluginId): boolean
# Parameters
| Name | Type |
|---|---|
pluginId | string |
# Returns
boolean
# Defined in
types/index.d.ts:547 (opens new window)
# isPointInArea
▸ isPointInArea(point): boolean
# Parameters
| Name | Type |
|---|---|
point | Point |
# Returns
boolean
# Defined in
types/index.d.ts:523 (opens new window)
# notifyPlugins
▸ notifyPlugins(hook, args?): boolean | void
# Parameters
| Name | Type |
|---|---|
hook | string |
args? | AnyObject |
# Returns
boolean | void
# Defined in
types/index.d.ts:545 (opens new window)
# render
▸ render(): void
# Returns
void
# Defined in
types/index.d.ts:520 (opens new window)
# reset
▸ reset(): void
# Returns
void
# Defined in
types/index.d.ts:518 (opens new window)
# resize
▸ resize(width?, height?): void
# Parameters
| Name | Type |
|---|---|
width? | number |
height? | number |
# Returns
void
# Defined in
types/index.d.ts:514 (opens new window)
# setActiveElements
▸ setActiveElements(active): void
# Parameters
| Name | Type |
|---|---|
active | ActiveDataPoint[] |
# Returns
void
# Defined in
types/index.d.ts:537 (opens new window)
# setDatasetVisibility
▸ setDatasetVisibility(datasetIndex, visible): void
# Parameters
| Name | Type |
|---|---|
datasetIndex | number |
visible | boolean |
# Returns
void
# Defined in
types/index.d.ts:530 (opens new window)
# show
▸ show(datasetIndex, dataIndex?): void
# Parameters
| Name | Type |
|---|---|
datasetIndex | number |
dataIndex? | number |
# Returns
void
# Defined in
types/index.d.ts:534 (opens new window)
# stop
▸ stop(): Chart<TType, TData, TLabel>
# Returns
Chart<TType, TData, TLabel>
# Defined in
types/index.d.ts:512 (opens new window)
# toBase64Image
▸ toBase64Image(type?, quality?): string
# Parameters
| Name | Type |
|---|---|
type? | string |
quality? | unknown |
# Returns
string
# Defined in
types/index.d.ts:540 (opens new window)
# toggleDataVisibility
▸ toggleDataVisibility(index): void
# Parameters
| Name | Type |
|---|---|
index | number |
# Returns
void
# Defined in
types/index.d.ts:531 (opens new window)
# unbindEvents
▸ unbindEvents(): void
# Returns
void
# Defined in
types/index.d.ts:542 (opens new window)
# update
▸ update(mode?): void
# Parameters
| Name | Type |
|---|---|
mode? | "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" | (ctx: { datasetIndex: number }) => "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" |
# Returns
void
# Defined in
types/index.d.ts:519 (opens new window)
# updateHoverStyle
▸ updateHoverStyle(items, mode, enabled): void
# Parameters
| Name | Type |
|---|---|
items | InteractionItem[] |
mode | "dataset" |
enabled | boolean |
# Returns
void
# Defined in
types/index.d.ts:543 (opens new window)
# getChart
▸ Static getChart(key): Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
# Parameters
| Name | Type |
|---|---|
key | string | HTMLCanvasElement | CanvasRenderingContext2D |
# Returns
Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
# Defined in
types/index.d.ts:556 (opens new window)
# register
▸ Static register(...items): void
# Parameters
| Name | Type |
|---|---|
...items | ChartComponentLike[] |
# Returns
void
# Defined in
types/index.d.ts:557 (opens new window)
# unregister
▸ Static unregister(...items): void
# Parameters
| Name | Type |
|---|---|
...items | ChartComponentLike[] |
# Returns
void