Chart.js - v3.5.0

Enumerations

Classes

Interfaces

Type aliases

AnimationOptions

Ƭ AnimationOptions<TType>: Object

Type parameters

NameType
TTypeextends ChartType

Type declaration

NameType
animationfalse | AnimationSpec<TType> & { onComplete?: (event: AnimationEvent) => void ; onProgress?: (event: AnimationEvent) => void }
animationsAnimationsSpec<TType>
transitionsTransitionsSpec<TType>

Defined in

index.esm.d.ts:1587Exports - 图1 (opens new window)

AnimationSpec

Ƭ AnimationSpec<TType>: Object

Type parameters

NameType
TTypeextends ChartType

Type declaration

NameTypeDescription
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

index.esm.d.ts:1531Exports - 图2 (opens new window)

AnimationsSpec

Ƭ AnimationsSpec<TType>: Object

Type parameters

NameType
TTypeextends ChartType

Index signature

▪ [name: string]: false | AnimationSpec<TType> & { from: Scriptable<Color | number | boolean, ScriptableContext<TType>> ; properties: string[] ; to: Scriptable<Color | number | boolean, ScriptableContext<TType>> ; type: "color" | "number" | "boolean" ; fn: <T>(from: T, to: T, factor: number) => T }

Defined in

index.esm.d.ts:1556Exports - 图3 (opens new window)

BarController

Ƭ BarController: DatasetController

Defined in

index.esm.d.ts:142Exports - 图4 (opens new window)

BubbleController

Ƭ BubbleController: DatasetController

Defined in

index.esm.d.ts:170Exports - 图5 (opens new window)

CategoryScale

Ƭ CategoryScale<O>: Scale<O>

Type parameters

NameType
Oextends CategoryScaleOptionsCategoryScaleOptions

Defined in

index.esm.d.ts:2984Exports - 图6 (opens new window)

CategoryScaleOptions

Ƭ CategoryScaleOptions: CartesianScaleOptions & { labels: string[] | string[][] ; max: string | number ; min: string | number }

Defined in

index.esm.d.ts:2978Exports - 图7 (opens new window)

ChartComponentLike

Ƭ ChartComponentLike: ChartComponent | ChartComponent[] | { [key: string]: ChartComponent; }

Defined in

index.esm.d.ts:1063Exports - 图8 (opens new window)

ChartDataset

Ƭ ChartDataset<TType, TData>: DeepPartial<{ [key in ChartType]: object & ChartTypeRegistry[key][“datasetOptions”]}[TType]> & ChartDatasetProperties<TType, TData>

Type parameters

NameType
TTypeextends ChartTypeChartType
TDataDefaultDataPoint<TType>

Defined in

index.esm.d.ts:3464Exports - 图9 (opens new window)

ChartItem

Ƭ ChartItem: string | CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D | HTMLCanvasElement | OffscreenCanvas | { canvas: HTMLCanvasElement | OffscreenCanvas } | ArrayLike<CanvasRenderingContext2D | HTMLCanvasElement | OffscreenCanvas>

Defined in

index.esm.d.ts:535Exports - 图10 (opens new window)

ChartMeta

Ƭ ChartMeta<TElement, TDatasetElement, TType>: DeepPartial<{ [key in ChartType]: ChartTypeRegistry[key][“metaExtensions”]}[TType]> & ChartMetaCommon<TElement, TDatasetElement>

Type parameters

NameType
TElementextends ElementElement
TDatasetElementextends ElementElement
TTypeextends ChartTypeChartType

Defined in

index.esm.d.ts:445Exports - 图11 (opens new window)

ChartOptions

Ƭ ChartOptions<TType>: DeepPartial<CoreChartOptions<TType> & ElementChartOptions<TType> & PluginChartOptions<TType> & DatasetChartOptions<TType> & ScaleChartOptions<TType> & ChartTypeRegistry[TType]["chartOptions"]>

Type parameters

NameType
TTypeextends ChartTypeChartType

Defined in

index.esm.d.ts:3446Exports - 图12 (opens new window)

ChartType

Ƭ ChartType: keyof ChartTypeRegistry

Defined in

index.esm.d.ts:3425Exports - 图13 (opens new window)

Color

Ƭ Color: string | CanvasGradient | CanvasPattern

Defined in

color.d.ts:1Exports - 图14 (opens new window)

DatasetChartOptions

Ƭ DatasetChartOptions<TType>: { [key in TType]: object}

Type parameters

NameType
TTypeextends ChartTypeChartType

Defined in

index.esm.d.ts:3434Exports - 图15 (opens new window)

DecimationOptions

Ƭ DecimationOptions: LttbDecimationOptions | MinMaxDecimationOptions

Defined in

index.esm.d.ts:2037Exports - 图16 (opens new window)

DefaultDataPoint

Ƭ DefaultDataPoint<TType>: DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>

Type parameters

NameType
TTypeextends ChartType

Defined in

index.esm.d.ts:3455Exports - 图17 (opens new window)

DoughnutDataPoint

Ƭ DoughnutDataPoint: number

Defined in

index.esm.d.ts:316Exports - 图18 (opens new window)

EasingFunction

Ƭ EasingFunction: "linear" | "easeInQuad" | "easeOutQuad" | "easeInOutQuad" | "easeInCubic" | "easeOutCubic" | "easeInOutCubic" | "easeInQuart" | "easeOutQuart" | "easeInOutQuart" | "easeInQuint" | "easeOutQuint" | "easeInOutQuint" | "easeInSine" | "easeOutSine" | "easeInOutSine" | "easeInExpo" | "easeOutExpo" | "easeInOutExpo" | "easeInCirc" | "easeOutCirc" | "easeInOutCirc" | "easeInElastic" | "easeOutElastic" | "easeInOutElastic" | "easeInBack" | "easeOutBack" | "easeInOutBack" | "easeInBounce" | "easeOutBounce" | "easeInOutBounce"

Defined in

index.esm.d.ts:1498Exports - 图19 (opens new window)

ElementChartOptions

Ƭ ElementChartOptions<TType>: Object

Type parameters

NameType
TTypeextends ChartTypeChartType

Type declaration

NameType
elementsElementOptionsByType<TType>

Defined in

index.esm.d.ts:1958Exports - 图20 (opens new window)

FillTarget

Ƭ FillTarget: number | string | { value: number } | "start" | "end" | "origin" | "stack" | "shape" | boolean

Defined in

index.esm.d.ts:2045Exports - 图21 (opens new window)

InteractionMode

Ƭ InteractionMode: keyof InteractionModeMap

Defined in

index.esm.d.ts:730Exports - 图22 (opens new window)

InteractionModeFunction

Ƭ InteractionModeFunction: (chart: Chart, e: ChartEvent, options: InteractionOptions, useFinalPosition?: boolean) => InteractionItem[]

Type declaration

▸ (chart, e, options, useFinalPosition?): InteractionItem[]

Parameters
NameType
chartChart
eChartEvent
optionsInteractionOptions
useFinalPosition?boolean
Returns

InteractionItem[]

Defined in

index.esm.d.ts:692Exports - 图23 (opens new window)

LayoutPosition

Ƭ LayoutPosition: "left" | "top" | "right" | "bottom" | "center" | "chartArea" | { [scaleId: string]: number; }

Defined in

layout.d.ts:3Exports - 图24 (opens new window)

LineController

Ƭ LineController: DatasetController

Defined in

index.esm.d.ts:214Exports - 图25 (opens new window)

LinearScale

Ƭ LinearScale<O>: Scale<O>

Type parameters

NameType
Oextends LinearScaleOptionsLinearScaleOptions

Defined in

index.esm.d.ts:3039Exports - 图26 (opens new window)

LinearScaleOptions

Ƭ LinearScaleOptions: CartesianScaleOptions & { beginAtZero: boolean ; grace?: string | number ; suggestedMax?: number ; suggestedMin?: number ; ticks: { count: number ; format: Intl.NumberFormatOptions ; maxTicksLimit: number ; precision: number ; stepSize: number } }

Defined in

index.esm.d.ts:2990Exports - 图27 (opens new window)

LogarithmicScale

Ƭ LogarithmicScale<O>: Scale<O>

Type parameters

NameType
Oextends LogarithmicScaleOptionsLogarithmicScaleOptions

Defined in

index.esm.d.ts:3064Exports - 图28 (opens new window)

LogarithmicScaleOptions

Ƭ LogarithmicScaleOptions: CartesianScaleOptions & { suggestedMax?: number ; suggestedMin?: number ; ticks: { format: Intl.NumberFormatOptions } }

Defined in

index.esm.d.ts:3045Exports - 图29 (opens new window)

Overrides

Ƭ Overrides: { [key in ChartType]: CoreChartOptions<key> & ElementChartOptions<key> & PluginChartOptions<key> & DatasetChartOptions<ChartType> & ScaleChartOptions<key> & ChartTypeRegistry[key][“chartOptions”]}

Defined in

index.esm.d.ts:670Exports - 图30 (opens new window)

ParsedDataType

Ƭ ParsedDataType<TType>: ChartTypeRegistry[TType]["parsedDataType"]

Type parameters

NameType
TTypeextends ChartTypeChartType

Defined in

index.esm.d.ts:3457Exports - 图31 (opens new window)

PieAnimationOptions

Ƭ PieAnimationOptions: DoughnutAnimationOptions

Defined in

index.esm.d.ts:339Exports - 图32 (opens new window)

PieController

Ƭ PieController: DoughnutController

Defined in

index.esm.d.ts:344Exports - 图33 (opens new window)

PieControllerChartOptions

Ƭ PieControllerChartOptions: DoughnutControllerChartOptions

Defined in

index.esm.d.ts:338Exports - 图34 (opens new window)

PieControllerDatasetOptions

Ƭ PieControllerDatasetOptions: DoughnutControllerDatasetOptions

Defined in

index.esm.d.ts:337Exports - 图35 (opens new window)

PieDataPoint

Ƭ PieDataPoint: DoughnutDataPoint

Defined in

index.esm.d.ts:341Exports - 图36 (opens new window)

PieMetaExtensions

Ƭ PieMetaExtensions: DoughnutMetaExtensions

Defined in

index.esm.d.ts:342Exports - 图37 (opens new window)

PointStyle

Ƭ PointStyle: "circle" | "cross" | "crossRot" | "dash" | "line" | "rect" | "rectRounded" | "rectRot" | "star" | "triangle" | HTMLImageElement | HTMLCanvasElement

Defined in

index.esm.d.ts:1795Exports - 图38 (opens new window)

PolarAreaAnimationOptions

Ƭ PolarAreaAnimationOptions: DoughnutAnimationOptions

Defined in

index.esm.d.ts:358Exports - 图39 (opens new window)

RadarController

Ƭ RadarController: DatasetController

Defined in

index.esm.d.ts:405Exports - 图40 (opens new window)

RadarControllerChartOptions

Ƭ RadarControllerChartOptions: LineControllerChartOptions

Defined in

index.esm.d.ts:403Exports - 图41 (opens new window)

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: GridLineOptions ; max: number ; min: number ; pointLabels: { backdropColor: Scriptable<Color, ScriptableScalePointLabelContext> ; backdropPadding: Scriptable<number | ChartArea, ScriptableScalePointLabelContext> ; color: Scriptable<Color, ScriptableScalePointLabelContext> ; display: boolean ; font: Scriptable<FontSpec, ScriptableScalePointLabelContext> ; callback: (label: string, index: number) => string } ; suggestedMax: number ; suggestedMin: number ; ticks: TickOptions & { count: number ; format: Intl.NumberFormatOptions ; maxTicksLimit: number ; precision: number ; stepSize: number } }

Defined in

index.esm.d.ts:3161Exports - 图42 (opens new window)

ScaleChartOptions

Ƭ ScaleChartOptions<TType>: Object

Type parameters

NameType
TTypeextends ChartTypeChartType

Type declaration

NameType
scalesObject

Defined in

index.esm.d.ts:3440Exports - 图43 (opens new window)

ScaleOptions

Ƭ ScaleOptions<TScale>: DeepPartial<ScaleOptionsByType<TScale>>

Type parameters

NameType
TScaleextends ScaleTypeScaleType

Defined in

index.esm.d.ts:3432Exports - 图44 (opens new window)

ScaleOptionsByType

Ƭ ScaleOptionsByType<TScale>: { [key in ScaleType]: object & ScaleTypeRegistry[key][“options”]}[TScale]

Type parameters

NameType
TScaleextends ScaleTypeScaleType

Defined in

index.esm.d.ts:3427Exports - 图45 (opens new window)

ScaleType

Ƭ ScaleType: keyof ScaleTypeRegistry

Defined in

index.esm.d.ts:3321Exports - 图46 (opens new window)

ScatterController

Ƭ ScatterController: LineController

Defined in

index.esm.d.ts:229Exports - 图47 (opens new window)

ScatterControllerChartOptions

Ƭ ScatterControllerChartOptions: LineControllerChartOptions

Defined in

index.esm.d.ts:227Exports - 图48 (opens new window)

ScatterControllerDatasetOptions

Ƭ ScatterControllerDatasetOptions: LineControllerDatasetOptions

Defined in

index.esm.d.ts:220Exports - 图49 (opens new window)

Scriptable

Ƭ Scriptable<T, TContext>: T | (ctx: TContext, options: AnyObject) => T

Type parameters

Name
T
TContext

Defined in

index.esm.d.ts:37Exports - 图50 (opens new window)

ScriptableAndArray

Ƭ ScriptableAndArray<T, TContext>: readonly T[] | Scriptable<T, TContext>

Type parameters

Name
T
TContext

Defined in

index.esm.d.ts:39Exports - 图51 (opens new window)

ScriptableAndArrayOptions

Ƭ ScriptableAndArrayOptions<T, TContext>: { [P in keyof T]: ScriptableAndArray<T[P], TContext>}

Type parameters

Name
T
TContext

Defined in

index.esm.d.ts:40Exports - 图52 (opens new window)

ScriptableOptions

Ƭ ScriptableOptions<T, TContext>: { [P in keyof T]: Scriptable<T[P], TContext>}

Type parameters

Name
T
TContext

Defined in

index.esm.d.ts:38Exports - 图53 (opens new window)

TextAlign

Ƭ TextAlign: "left" | "center" | "right"

Defined in

index.esm.d.ts:1629Exports - 图54 (opens new window)

TimeScaleOptions

Ƭ TimeScaleOptions: CartesianScaleOptions & { adapters: { date: unknown } ; bounds: "ticks" | "data" ; ticks: { source: "labels" | "auto" | "data" } ; time: { displayFormats: { [key: string]: string; } ; isoWeekday: boolean | number ; minUnit: TimeUnit ; parser: string | (v: unknown) => number ; round: false | TimeUnit ; stepSize: number ; tooltipFormat: string ; unit: false | TimeUnit } }

Defined in

index.esm.d.ts:3070Exports - 图55 (opens new window)

TimeSeriesScale

Ƭ TimeSeriesScale<O>: TimeScale<O>

Type parameters

NameType
Oextends TimeScaleOptionsTimeScaleOptions

Defined in

index.esm.d.ts:3155Exports - 图56 (opens new window)

TimeUnit

Ƭ TimeUnit: "millisecond" | "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"

Defined in

adapters.d.ts:1Exports - 图57 (opens new window)

TooltipXAlignment

Ƭ TooltipXAlignment: "left" | "center" | "right"

Defined in

index.esm.d.ts:2341Exports - 图58 (opens new window)

TooltipYAlignment

Ƭ TooltipYAlignment: "top" | "center" | "bottom"

Defined in

index.esm.d.ts:2342Exports - 图59 (opens new window)

TransitionSpec

Ƭ TransitionSpec<TType>: Object

Type parameters

NameType
TTypeextends ChartType

Type declaration

NameType
animationAnimationSpec<TType>
animationsAnimationsSpec<TType>

Defined in

index.esm.d.ts:1578Exports - 图60 (opens new window)

TransitionsSpec

Ƭ TransitionsSpec<TType>: Object

Type parameters

NameType
TTypeextends ChartType

Index signature

▪ [mode: string]: TransitionSpec<TType>

Defined in

index.esm.d.ts:1583Exports - 图61 (opens new window)

UpdateMode

Ƭ UpdateMode: keyof typeof UpdateModeEnum

Defined in

index.esm.d.ts:554Exports - 图62 (opens new window)

Variables

ArcElement

• ArcElement: ChartComponent & { prototype: ArcElement<ArcProps, ArcOptions> }

Defined in

index.esm.d.ts:1699Exports - 图63 (opens new window)

BarController

• BarController: ChartComponent & { prototype: BarController }

Defined in

index.esm.d.ts:143Exports - 图64 (opens new window)

BarElement

• BarElement: ChartComponent & { prototype: BarElement<BarProps, BarOptions> }

Defined in

index.esm.d.ts:1946Exports - 图65 (opens new window)

BubbleController

• BubbleController: ChartComponent & { prototype: BubbleController }

Defined in

index.esm.d.ts:171Exports - 图66 (opens new window)

CategoryScale

• CategoryScale: ChartComponent & { prototype: CategoryScale<CategoryScaleOptions> }

Defined in

index.esm.d.ts:2985Exports - 图67 (opens new window)

Decimation

• Const Decimation: Plugin

Defined in

index.esm.d.ts:2017Exports - 图68 (opens new window)

DoughnutController

• DoughnutController: ChartComponent & { prototype: DoughnutController }

Defined in

index.esm.d.ts:328Exports - 图69 (opens new window)

Element

• Element: Object

Type declaration

NameType
prototypeElement<AnyObject, AnyObject>

Defined in

element.d.ts:14Exports - 图70 (opens new window)

Filler

• Const Filler: Plugin

Defined in

index.esm.d.ts:2039Exports - 图71 (opens new window)

Interaction

• Const Interaction: Object

Type declaration

NameType
modesInteractionModeMap

Defined in

index.esm.d.ts:732Exports - 图72 (opens new window)

Legend

• Const Legend: Plugin

Defined in

index.esm.d.ts:2069Exports - 图73 (opens new window)

LineController

• LineController: ChartComponent & { prototype: LineController }

Defined in

index.esm.d.ts:215Exports - 图74 (opens new window)

LineElement

• LineElement: ChartComponent & { prototype: LineElement<LineProps, LineOptions> }

Defined in

index.esm.d.ts:1785Exports - 图75 (opens new window)

LinearScale

• LinearScale: ChartComponent & { prototype: LinearScale<LinearScaleOptions> }

Defined in

index.esm.d.ts:3040Exports - 图76 (opens new window)

LogarithmicScale

• LogarithmicScale: ChartComponent & { prototype: LogarithmicScale<LogarithmicScaleOptions> }

Defined in

index.esm.d.ts:3065Exports - 图77 (opens new window)

PieController

• PieController: ChartComponent & { prototype: DoughnutController }

Defined in

index.esm.d.ts:345Exports - 图78 (opens new window)

PointElement

• PointElement: ChartComponent & { prototype: PointElement<PointProps, PointOptions> }

Defined in

index.esm.d.ts:1897Exports - 图79 (opens new window)

PolarAreaController

• PolarAreaController: ChartComponent & { prototype: PolarAreaController }

Defined in

index.esm.d.ts:373Exports - 图80 (opens new window)

RadarController

• RadarController: ChartComponent & { prototype: RadarController }

Defined in

index.esm.d.ts:406Exports - 图81 (opens new window)

RadialLinearScale

• RadialLinearScale: ChartComponent & { prototype: RadialLinearScale<RadialLinearScaleOptions> }

Defined in

index.esm.d.ts:3289Exports - 图82 (opens new window)

ScatterController

• ScatterController: ChartComponent & { prototype: LineController }

Defined in

index.esm.d.ts:230Exports - 图83 (opens new window)

SubTitle

• Const SubTitle: Plugin

Defined in

index.esm.d.ts:2299Exports - 图84 (opens new window)

Ticks

• Const Ticks: Object

Type declaration

NameType
formattersObject
formatters.logarithmic[object Object]
formatters.numeric[object Object]
formatters.values[object Object]

Defined in

index.esm.d.ts:1305Exports - 图85 (opens new window)

TimeScale

• TimeScale: ChartComponent & { prototype: TimeScale<TimeScaleOptions> }

Defined in

index.esm.d.ts:3150Exports - 图86 (opens new window)

TimeSeriesScale

• TimeSeriesScale: ChartComponent & { prototype: TimeSeriesScale<TimeScaleOptions> }

Defined in

index.esm.d.ts:3156Exports - 图87 (opens new window)

Title

• Const Title: Plugin

Defined in

index.esm.d.ts:2300Exports - 图88 (opens new window)

Tooltip

• Const Tooltip: Plugin & { positioners: { [key: string]: (items: readonly ActiveElement[], eventPosition: { x: number ; y: number }) => { x: number ; y: number } | false; } ; getActiveElements: () => ActiveElement[] ; setActiveElements: (active: ActiveDataPoint[], eventPosition: { x: number ; y: number }) => void }

Defined in

index.esm.d.ts:2420Exports - 图89 (opens new window)

_adapters

• Const _adapters: Object

Type declaration

NameType
_dateDateAdapter

Defined in

adapters.d.ts:61Exports - 图90 (opens new window)

defaults

• Const defaults: Defaults

Defined in

index.esm.d.ts:680Exports - 图91 (opens new window)

layouts

• Const layouts: Object

Type declaration

NameType
addBox(chart: Chart<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, item: LayoutItem) => void
configure(chart: Chart<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, item: LayoutItem, options: { fullSize?: number ; position?: LayoutPosition ; weight?: number }) => void
removeBox(chart: Chart<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, layoutItem: LayoutItem) => void
update(chart: Chart<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, width: number, height: number) => void

Defined in

index.esm.d.ts:736Exports - 图92 (opens new window)

registerables

• Const registerables: readonly ChartComponentLike[]

Defined in

index.esm.d.ts:533Exports - 图93 (opens new window)

registry

• Const registry: Registry

Defined in

index.esm.d.ts:1089Exports - 图94 (opens new window)