# Chart.js - v4.5.0
# Enumerations
# Classes
- Animation
- Animations
- Animator
- ArcElement
- BasePlatform
- BasicPlatform
- Chart
- DatasetController
- DomPlatform
- PointElement
- Scale
# Interfaces
- ActiveDataPoint
- ActiveElement
- AnimationEvent
- ArcBorderRadius
- ArcHoverOptions
- ArcOptions
- ArcProps
- BackdropOptions
- BarControllerChartOptions
- BarControllerDatasetOptions
- BarElement
- BarHoverOptions
- BarOptions
- BarParsedData
- BarProps
- BorderOptions
- BorderRadius
- BubbleControllerDatasetOptions
- BubbleDataPoint
- BubbleParsedData
- CanvasFontSpec
- CartesianParsedData
- CartesianScaleOptions
- CartesianScaleTypeRegistry
- ChartArea
- ChartComponent
- ChartConfiguration
- ChartConfigurationCustomTypesPerDataset
- ChartData
- ChartDataCustomTypesPerDataset
- ChartDatasetProperties
- ChartDatasetPropertiesCustomTypesPerDataset
- ChartEvent
- ChartTypeRegistry
- CommonElementOptions
- CommonHoverOptions
- ComplexFillTarget
- ControllerDatasetOptions
- CoreChartOptions
- CoreInteractionOptions
- CoreScaleOptions
- DatasetControllerChartComponent
- Defaults
- DoughnutAnimationOptions
- DoughnutController
- DoughnutControllerChartOptions
- DoughnutControllerDatasetOptions
- DoughnutMetaExtensions
- ElementOptionsByType
- ExtendedPlugin
- FillerControllerDatasetOptions
- FillerOptions
- FontSpec
- GridLineOptions
- InteractionItem
- InteractionModeMap
- InteractionOptions
- LabelItem
- LayoutItem
- LegendElement
- LegendItem
- LegendOptions
- LineControllerChartOptions
- LineControllerDatasetOptions
- LineElement
- LineHoverOptions
- LineOptions
- LineProps
- ParsingOptions
- Plugin
- PluginChartOptions
- PluginDatasetOptionsByType
- PluginOptionsByType
- Point
- PointHoverOptions
- PointOptions
- PointPrefixedHoverOptions
- PointPrefixedOptions
- PolarAreaController
- PolarAreaControllerChartOptions
- PolarAreaControllerDatasetOptions
- RadarControllerDatasetOptions
- RadialLinearScale
- RadialParsedData
- RadialScaleTypeRegistry
- Registry
- RenderTextOpts
- ScaleTypeRegistry
- ScriptableCartesianScaleContext
- ScriptableChartContext
- ScriptableContext
- ScriptableLineSegmentContext
- ScriptableScaleContext
- ScriptableScalePointLabelContext
- ScriptableTooltipContext
- Segment
- Tick
- TickOptions
- TimeScale
- TitleOptions
- Tooltip
- TooltipCallbacks
- TooltipDatasetCallbacks
- TooltipDatasetOptions
- TooltipItem
- TooltipLabelStyle
- TooltipModel
- TooltipOptions
- TooltipPosition
- TooltipPositionerMap
- TypedRegistry
- VisualElement
# Type Aliases
# Align
Ƭ Align: "start" | "center" | "end"
# Defined in
types/index.d.ts:1814
# AnimationOptions
Ƭ AnimationOptions<TType>: Object
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType |
# Type declaration
| Name | Type |
|---|---|
animation | false | AnimationSpec<TType> & { onComplete?: (this: Chart, event: AnimationEvent) => void ; onProgress?: (this: Chart, event: AnimationEvent) => void } |
animations | AnimationsSpec<TType> |
transitions | TransitionsSpec<TType> |
# Defined in
types/index.d.ts:1767
# AnimationSpec
Ƭ AnimationSpec<TType>: Object
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType |
# Type declaration
| Name | Type | Description |
|---|---|---|
delay? | Scriptable<number, ScriptableContext<TType>> | Delay before starting the animations. Default 0 |
duration? | Scriptable<number, ScriptableContext<TType>> | The number of milliseconds an animation takes. Default 1000 |
easing? | Scriptable<EasingFunction, ScriptableContext<TType>> | Easing function to use Default 'easeOutQuart' |
loop? | Scriptable<boolean, ScriptableContext<TType>> | If set to true, the animations loop endlessly. Default false |
# Defined in
types/index.d.ts:1711
# AnimationsSpec
Ƭ AnimationsSpec<TType>: Object
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType |
# Index signature
▪ [name: string]: false | AnimationSpec<TType> & { fn: <T>(from: T, to: T, factor: number) => T ; from: Scriptable<Color | number | boolean, ScriptableContext<TType>> ; properties: string[] ; to: Scriptable<Color | number | boolean, ScriptableContext<TType>> ; type: "color" | "number" | "boolean" }
# Defined in
types/index.d.ts:1736
# BarController
Ƭ BarController: DatasetController
# Defined in
types/index.d.ts:156
types/index.d.ts:157
# BubbleController
Ƭ BubbleController: DatasetController
# Defined in
types/index.d.ts:183
types/index.d.ts:184
# CartesianTickOptions
Ƭ CartesianTickOptions: TickOptions & { align: Align | "inner" ; autoSkip: boolean ; autoSkipPadding: number ; crossAlign: "near" | "center" | "far" ; includeBounds: boolean ; labelOffset: number ; maxRotation: number ; maxTicksLimit: number ; minRotation: number ; mirror: boolean ; padding: number ; sampleSize: number }
# Defined in
types/index.d.ts:3134
# CategoryScale
Ƭ CategoryScale<O>: Scale<O>
# Type parameters
| Name | Type |
|---|---|
O | extends CategoryScaleOptions = CategoryScaleOptions |
# Defined in
types/index.d.ts:3301
types/index.d.ts:3302
# CategoryScaleOptions
Ƭ CategoryScaleOptions: Omit<CartesianScaleOptions, "min" | "max"> & { labels: string[] | string[][] ; max: string | number ; min: string | number }
# Defined in
types/index.d.ts:3295
# ChartComponentLike
Ƭ ChartComponentLike: ChartComponent | ChartComponent[] | { [key: string]: ChartComponent; } | Plugin | Plugin[]
# Defined in
types/index.d.ts:1136
# ChartDataset
Ƭ ChartDataset<TType, TData>: DeepPartial<{ [key in ChartType]: Object & ChartTypeRegistry[key]["datasetOptions"] }[TType]> & DeepPartial<PluginDatasetOptionsByType<TType>> & ChartDatasetProperties<TType, TData>
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType = ChartType |
TData | DefaultDataPoint<TType> |
# Defined in
types/index.d.ts:3819
# ChartDatasetCustomTypesPerDataset
Ƭ ChartDatasetCustomTypesPerDataset<TType, TData>: DeepPartial<{ [key in ChartType]: Object & ChartTypeRegistry[key]["datasetOptions"] }[TType]> & DeepPartial<PluginDatasetOptionsByType<TType>> & ChartDatasetPropertiesCustomTypesPerDataset<TType, TData>
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType = ChartType |
TData | DefaultDataPoint<TType> |
# Defined in
types/index.d.ts:3828
# ChartItem
Ƭ ChartItem: string | CanvasRenderingContext2D | HTMLCanvasElement | { canvas: HTMLCanvasElement } | ArrayLike<CanvasRenderingContext2D | HTMLCanvasElement>
# Defined in
types/index.d.ts:573
# ChartMeta
Ƭ ChartMeta<TType, TElement, TDatasetElement>: DeepPartial<{ [key in ChartType]: ChartTypeRegistry[key]["metaExtensions"] }[TType]> & ChartMetaCommon<TElement, TDatasetElement>
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType = ChartType |
TElement | extends Element = Element |
TDatasetElement | extends Element = Element |
# Defined in
types/index.d.ts:477
# ChartOptions
Ƭ ChartOptions<TType>: Exclude<DeepPartial<CoreChartOptions<TType> & ElementChartOptions<TType> & PluginChartOptions<TType> & DatasetChartOptions<TType> & ScaleChartOptions<TType> & ChartTypeRegistry[TType]["chartOptions"]>, DeepPartial<unknown[]>>
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType = ChartType |
# Defined in
types/index.d.ts:3793
# ChartType
Ƭ ChartType: keyof ChartTypeRegistry
# Defined in
types/index.d.ts:3772
# Color
Ƭ Color: string | CanvasGradient | CanvasPattern
# Defined in
types/color.d.ts:1
# DatasetChartOptions
Ƭ DatasetChartOptions<TType>: { [key in TType]: Object }
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType = ChartType |
# Defined in
types/index.d.ts:3781
# DecimationOptions
Ƭ DecimationOptions: LttbDecimationOptions | MinMaxDecimationOptions
# Defined in
types/index.d.ts:2247
# DefaultDataPoint
Ƭ DefaultDataPoint<TType>: DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType |
# Defined in
types/index.d.ts:3805
# DoughnutDataPoint
Ƭ DoughnutDataPoint: number
# Defined in
types/index.d.ts:338
# EasingFunction
Ƭ EasingFunction: keyof typeof effects
# Defined in
helpers/helpers.easing.ts:122
# ElementChartOptions
Ƭ ElementChartOptions<TType>: Object
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType = ChartType |
# Type declaration
| Name | Type |
|---|---|
elements | ElementOptionsByType<TType> |
# Defined in
types/index.d.ts:2163
# FillTarget
Ƭ FillTarget: number | string | { value: number } | "start" | "end" | "origin" | "stack" | "shape" | boolean
# Defined in
types/index.d.ts:2255
# InteractionAxis
Ƭ InteractionAxis: "x" | "y" | "xy" | "r"
# Defined in
types/index.d.ts:1573
# InteractionMode
Ƭ InteractionMode: keyof InteractionModeMap
# Defined in
types/index.d.ts:771
# InteractionModeFunction
Ƭ InteractionModeFunction: (chart: Chart, e: ChartEvent, options: InteractionOptions, useFinalPosition?: boolean) => InteractionItem[]
# Type declaration
▸ (chart, e, options, useFinalPosition?): InteractionItem[]
# Parameters
| Name | Type |
|---|---|
chart | Chart |
e | ChartEvent |
options | InteractionOptions |
useFinalPosition? | boolean |
# Returns
# Defined in
types/index.d.ts:733
# LayoutPosition
Ƭ LayoutPosition: "left" | "top" | "right" | "bottom" | "center" | "chartArea" | { [scaleId: string]: number; }
# Defined in
types/layout.d.ts:3
# LineController
Ƭ LineController: DatasetController
# Defined in
types/index.d.ts:229
types/index.d.ts:230
# LinearScale
Ƭ LinearScale<O>: Scale<O>
# Type parameters
| Name | Type |
|---|---|
O | extends LinearScaleOptions = LinearScaleOptions |
# Defined in
types/index.d.ts:3350
types/index.d.ts:3351
# LinearScaleOptions
Ƭ LinearScaleOptions: CartesianScaleOptions & { beginAtZero: boolean ; grace?: string | number ; suggestedMax?: number ; suggestedMin?: number ; ticks: { count: number ; format: Intl.NumberFormatOptions ; precision: number ; stepSize: number } }
# Defined in
types/index.d.ts:3307
# LogarithmicScale
Ƭ LogarithmicScale<O>: Scale<O>
# Type parameters
| Name | Type |
|---|---|
O | extends LogarithmicScaleOptions = LogarithmicScaleOptions |
# Defined in
types/index.d.ts:3374
types/index.d.ts:3375
# LogarithmicScaleOptions
Ƭ LogarithmicScaleOptions: CartesianScaleOptions & { suggestedMax?: number ; suggestedMin?: number ; ticks: { format: Intl.NumberFormatOptions } }
# Defined in
types/index.d.ts:3356
# Overrides
Ƭ Overrides: { [key in ChartType]: CoreChartOptions<key> & ElementChartOptions<key> & PluginChartOptions<key> & DatasetChartOptions<ChartType> & ScaleChartOptions<key> & ChartTypeRegistry[key]["chartOptions"] }
# Defined in
types/index.d.ts:710
# ParsedDataType
Ƭ ParsedDataType<TType>: ChartTypeRegistry[TType]["parsedDataType"]
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType = ChartType |
# Defined in
types/index.d.ts:3807
# PieAnimationOptions
Ƭ PieAnimationOptions: DoughnutAnimationOptions
# Defined in
types/index.d.ts:361
# PieController
Ƭ PieController: DoughnutController
# Defined in
types/index.d.ts:366
types/index.d.ts:367
# PieControllerChartOptions
Ƭ PieControllerChartOptions: DoughnutControllerChartOptions
# Defined in
types/index.d.ts:360
# PieControllerDatasetOptions
Ƭ PieControllerDatasetOptions: DoughnutControllerDatasetOptions
# Defined in
types/index.d.ts:359
# PieDataPoint
Ƭ PieDataPoint: DoughnutDataPoint
# Defined in
types/index.d.ts:363
# PieMetaExtensions
Ƭ PieMetaExtensions: DoughnutMetaExtensions
# Defined in
types/index.d.ts:364
# PointProps
Ƭ PointProps: Point
# Defined in
elements/element.point.ts:18
# PointStyle
Ƭ PointStyle: "circle" | "cross" | "crossRot" | "dash" | "line" | "rect" | "rectRounded" | "rectRot" | "star" | "triangle" | false | HTMLImageElement | HTMLCanvasElement
# Defined in
types/index.d.ts:1995
# PolarAreaAnimationOptions
Ƭ PolarAreaAnimationOptions: DoughnutAnimationOptions
# Defined in
types/index.d.ts:380
# RadarController
Ƭ RadarController: DatasetController
# Defined in
types/index.d.ts:427
types/index.d.ts:428
# RadarControllerChartOptions
Ƭ RadarControllerChartOptions: LineControllerChartOptions
# Defined in
types/index.d.ts:425
# RadialLinearScaleOptions
Ƭ RadialLinearScaleOptions: CoreScaleOptions & { angleLines: { borderDash: Scriptable<number[], ScriptableScaleContext> ; borderDashOffset: Scriptable<number, ScriptableScaleContext> ; color: Scriptable<Color, ScriptableScaleContext> ; display: boolean ; lineWidth: Scriptable<number, ScriptableScaleContext> } ; animate: boolean ; beginAtZero: boolean ; grid: Partial<GridLineOptions> ; max: number ; min: number ; pointLabels: { backdropColor: Scriptable<Color, ScriptableScalePointLabelContext> ; backdropPadding: Scriptable<number | ChartArea, ScriptableScalePointLabelContext> ; borderRadius: Scriptable<number | BorderRadius, ScriptableScalePointLabelContext> ; callback: (label: string, index: number) => string | string[] | number | number[] ; centerPointLabels: boolean ; color: Scriptable<Color, ScriptableScalePointLabelContext> ; display: boolean | "auto" ; font: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableScalePointLabelContext> ; padding: Scriptable<number, ScriptableScalePointLabelContext> } ; startAngle: number ; suggestedMax: number ; suggestedMin: number ; ticks: RadialTickOptions }
# Defined in
types/index.d.ts:3514
# RadialTickOptions
Ƭ RadialTickOptions: TickOptions & { count: number ; format: Intl.NumberFormatOptions ; maxTicksLimit: number ; precision: number ; stepSize: number }
# Defined in
types/index.d.ts:3486
# ScaleChartOptions
Ƭ ScaleChartOptions<TType>: Object
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType = ChartType |
# Type declaration
| Name | Type |
|---|---|
scales | { [key: string]: ScaleOptionsByType<ChartTypeRegistry[TType]["scales"]>; } |
# Defined in
types/index.d.ts:3787
# ScaleOptions
Ƭ ScaleOptions<TScale>: DeepPartial<ScaleOptionsByType<TScale>>
# Type parameters
| Name | Type |
|---|---|
TScale | extends ScaleType = ScaleType |
# Defined in
types/index.d.ts:3779
# ScaleOptionsByType
Ƭ ScaleOptionsByType<TScale>: { [key in ScaleType]: Object & ScaleTypeRegistry[key]["options"] }[TScale]
# Type parameters
| Name | Type |
|---|---|
TScale | extends ScaleType = ScaleType |
# Defined in
types/index.d.ts:3774
# ScaleType
Ƭ ScaleType: keyof ScaleTypeRegistry
# Defined in
types/index.d.ts:3671
# ScatterController
Ƭ ScatterController: LineController
# Defined in
types/index.d.ts:241
types/index.d.ts:242
# ScatterControllerChartOptions
Ƭ ScatterControllerChartOptions: LineControllerChartOptions
# Defined in
types/index.d.ts:239
# ScatterControllerDatasetOptions
Ƭ ScatterControllerDatasetOptions: LineControllerDatasetOptions
# Defined in
types/index.d.ts:235
# ScatterDataPoint
Ƭ ScatterDataPoint: Point
# Defined in
types/index.d.ts:237
# Scriptable
Ƭ Scriptable<T, TContext>: T | (ctx: TContext, options: AnyObject) => T | undefined
# Type parameters
| Name |
|---|
T |
TContext |
# Defined in
types/index.d.ts:44
# ScriptableAndArray
Ƭ ScriptableAndArray<T, TContext>: readonly T[] | Scriptable<T, TContext>
# Type parameters
| Name |
|---|
T |
TContext |
# Defined in
types/index.d.ts:47
# ScriptableAndArrayOptions
Ƭ ScriptableAndArrayOptions<T, TContext>: { [P in keyof T]: ScriptableAndArray<T[P], TContext> }
# Type parameters
| Name |
|---|
T |
TContext |
# Defined in
types/index.d.ts:48
# ScriptableAndScriptableOptions
Ƭ ScriptableAndScriptableOptions<T, TContext>: Scriptable<T, TContext> | ScriptableOptions<T, TContext>
# Type parameters
| Name |
|---|
T |
TContext |
# Defined in
types/index.d.ts:46
# ScriptableOptions
Ƭ ScriptableOptions<T, TContext>: { [P in keyof T]: Scriptable<T[P], TContext> }
# Type parameters
| Name |
|---|
T |
TContext |
# Defined in
types/index.d.ts:45
# TRBL
Ƭ TRBL: Object
# Type declaration
| Name | Type |
|---|---|
bottom | number |
left | number |
right | number |
top | number |
# Defined in
types/geometric.d.ts:15
# TextAlign
Ƭ TextAlign: "left" | "center" | "right"
# Defined in
types/index.d.ts:1813
# TimeScaleOptions
Ƭ TimeScaleOptions: Omit<CartesianScaleOptions, "min" | "max"> & { adapters: { date: unknown } ; bounds: "ticks" | "data" ; max: string | number ; min: string | number ; offsetAfterAutoskip: boolean ; suggestedMax: string | number ; suggestedMin: string | number ; ticks: TimeScaleTickOptions ; time: TimeScaleTimeOptions }
# Defined in
types/index.d.ts:3435
# TimeScaleTickOptions
Ƭ TimeScaleTickOptions: Object
# Type declaration
| Name | Type | Description |
|---|---|---|
source | "labels" | "auto" | "data" | Ticks generation input values: - 'auto': generates "optimal" ticks based on scale size and time options. - 'data': generates ticks from data (including labels from data {t\|x\|y} objects). - 'labels': generates ticks from user given data.labels values ONLY. See https://github.com/chartjs/Chart.js/pull/4507 Since 2.7.0 Default 'auto' |
stepSize | number | The number of units between grid lines. Default 1 |
# Defined in
types/index.d.ts:3417
# TimeScaleTimeOptions
Ƭ TimeScaleTimeOptions: Object
# Type declaration
| Name | Type | Description |
|---|---|---|
displayFormats | { [key: string]: string; } | Sets how different time units are displayed. |
isoWeekday | boolean | number | If boolean and true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday. If number, the index of the first day of the week (0 - Sunday, 6 - Saturday). Default false |
minUnit | TimeUnit | The minimum display format to be used for a time unit. Default 'millisecond' |
parser | string | (v: unknown) => number | Custom parser for dates. |
round | false | TimeUnit | If defined, dates will be rounded to the start of this unit. See Time Units below for the allowed units. |
tooltipFormat | string | The format string to use for the tooltip. |
unit | false | TimeUnit | If defined, will force the unit to be a certain type. See Time Units section below for details. Default false |
# Defined in
types/index.d.ts:3380
# TimeSeriesScale
Ƭ TimeSeriesScale<O>: TimeScale<O>
# Type parameters
| Name | Type |
|---|---|
O | extends TimeScaleOptions = TimeScaleOptions |
# Defined in
types/index.d.ts:3480
types/index.d.ts:3481
# TooltipPositioner
Ƭ TooltipPositioner: keyof TooltipPositionerMap
# Defined in
types/index.d.ts:2673
# TooltipPositionerFunction
Ƭ TooltipPositionerFunction<TType>: (this: TooltipModel<TType>, items: readonly ActiveElement[], eventPosition: Point) => TooltipPosition | false
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType |
# Type declaration
▸ (this, items, eventPosition): TooltipPosition | false
# Parameters
| Name | Type |
|---|---|
this | TooltipModel<TType> |
items | readonly ActiveElement[] |
eventPosition | Point |
# Returns
TooltipPosition | false
# Defined in
types/index.d.ts:2662
# TooltipXAlignment
Ƭ TooltipXAlignment: "left" | "center" | "right"
# Defined in
types/index.d.ts:2573
# TooltipYAlignment
Ƭ TooltipYAlignment: "top" | "center" | "bottom"
# Defined in
types/index.d.ts:2574
# TransitionSpec
Ƭ TransitionSpec<TType>: Object
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType |
# Type declaration
| Name | Type |
|---|---|
animation | AnimationSpec<TType> |
animations | AnimationsSpec<TType> |
# Defined in
types/index.d.ts:1758
# TransitionsSpec
Ƭ TransitionsSpec<TType>: Object
# Type parameters
| Name | Type |
|---|---|
TType | extends ChartType |
# Index signature
▪ [mode: string]: TransitionSpec<TType>
# Defined in
types/index.d.ts:1763
# UpdateMode
Ƭ UpdateMode: keyof typeof UpdateModeEnum
# Defined in
types/index.d.ts:590
# Variables
# BarController
• BarController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => BarController
# Defined in
types/index.d.ts:156
types/index.d.ts:157
# BarElement
• BarElement: ChartComponent & (cfg: AnyObject) => BarElement<BarProps, BarOptions>
# Defined in
types/index.d.ts:2146
types/index.d.ts:2151
# BubbleController
• BubbleController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => BubbleController
# Defined in
types/index.d.ts:183
types/index.d.ts:184
# CategoryScale
• CategoryScale: ChartComponent & <O>(cfg: AnyObject) => CategoryScale<O>
# Defined in
types/index.d.ts:3301
types/index.d.ts:3302
# Decimation
• Const Decimation: Plugin
# Defined in
types/index.d.ts:2227
# DoughnutController
• DoughnutController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => DoughnutController
# Defined in
types/index.d.ts:340
types/index.d.ts:350
# Filler
• Const Filler: Plugin
# Defined in
types/index.d.ts:2249
# Interaction
• Const Interaction: Object
# Type declaration
| Name | Type |
|---|---|
modes | InteractionModeMap |
evaluateInteractionItems | (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, axis: InteractionAxis, position: Point, handler: (element: default<AnyObject, AnyObject> & VisualElement, datasetIndex: number, index: number) => void, intersect?: boolean) => InteractionItem[] |
# Defined in
types/index.d.ts:773
# Legend
• Const Legend: Plugin
# Defined in
types/index.d.ts:2279
# LineController
• LineController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => LineController
# Defined in
types/index.d.ts:229
types/index.d.ts:230
# LineElement
• LineElement: ChartComponent & (cfg: AnyObject) => LineElement<LineProps, LineOptions>
# Defined in
types/index.d.ts:1977
types/index.d.ts:1990
# LinearScale
• LinearScale: ChartComponent & <O>(cfg: AnyObject) => LinearScale<O>
# Defined in
types/index.d.ts:3350
types/index.d.ts:3351
# LogarithmicScale
• LogarithmicScale: ChartComponent & <O>(cfg: AnyObject) => LogarithmicScale<O>
# Defined in
types/index.d.ts:3374
types/index.d.ts:3375
# PieController
• PieController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => DoughnutController
# Defined in
types/index.d.ts:366
types/index.d.ts:367
# PolarAreaController
• PolarAreaController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => PolarAreaController
# Defined in
types/index.d.ts:392
types/index.d.ts:395
# RadarController
• RadarController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => RadarController
# Defined in
types/index.d.ts:427
types/index.d.ts:428
# RadialLinearScale
• RadialLinearScale: ChartComponent & <O>(cfg: AnyObject) => RadialLinearScale<O>
# Defined in
types/index.d.ts:3627
types/index.d.ts:3639
# ScatterController
• ScatterController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => LineController
# Defined in
types/index.d.ts:241
types/index.d.ts:242
# SubTitle
• Const SubTitle: Plugin
# Defined in
types/index.d.ts:2531
# Ticks
• Const Ticks: Object
# Type declaration
| Name | Type |
|---|---|
formatters | { logarithmic: (this: Scale<CoreScaleOptions>, tickValue: number, index: number, ticks: { value: number }[]) => string ; numeric: (this: Scale<CoreScaleOptions>, tickValue: number, index: number, ticks: { value: number }[]) => string ; values: (value: unknown) => string | string[] } |
formatters.logarithmic | [object Object] |
formatters.numeric | [object Object] |
formatters.values | [object Object] |
# Defined in
types/index.d.ts:1507
# TimeScale
• TimeScale: ChartComponent & <O>(cfg: AnyObject) => TimeScale<O>
# Defined in
types/index.d.ts:3468
types/index.d.ts:3475
# TimeSeriesScale
• TimeSeriesScale: ChartComponent & <O>(cfg: AnyObject) => TimeSeriesScale<O>
# Defined in
types/index.d.ts:3480
types/index.d.ts:3481
# Title
• Const Title: Plugin
# Defined in
types/index.d.ts:2532
# Tooltip
• Tooltip: Tooltip
# Defined in
types/index.d.ts:2675
types/index.d.ts:2679
# defaults
• Const defaults: Defaults
# Defined in
types/index.d.ts:720
# layouts
• Const layouts: Object
# Type declaration
| Name | Type |
|---|---|
addBox | (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, item: LayoutItem) => void |
configure | (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, item: LayoutItem, options: { fullSize?: number ; position?: LayoutPosition ; weight?: number }) => void |
removeBox | (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, layoutItem: LayoutItem) => void |
update | (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, width: number, height: number) => void |
# Defined in
types/index.d.ts:788
# registerables
• Const registerables: readonly ChartComponentLike[]
# Defined in
types/index.d.ts:571
# registry
• Const registry: Registry
# Defined in
types/index.d.ts:1162