Chart.js - v3.1.1

• UpdateModeEnum

Classes

• Animations
• BasePlatform
• Chart
• DomPlatform

Interfaces

• ActiveDataPoint
• AnimationEvent
• ArcElement
• ArcOptions
• BarControllerChartOptions
• BarElement
• BarOptions
• BorderRadius
• BubbleDataPoint
• ChartArea
• ChartConfiguration
• ChartDatasetProperties
• ChartMeta
• CommonElementOptions
• ComplexFillTarget
• CoreChartOptions
• CoreScaleOptions
• DateAdapter
• DoughnutAnimationOptions
• DoughnutControllerChartOptions
• Element
• ElementOptionsByType
• FillerControllerDatasetOptions
• FontSpec
• InteractionItem
• InteractionOptions
• LegendElement
• LegendOptions
• LineControllerDatasetOptions
• LineHoverOptions
• LineProps
• Plugin
• PluginOptionsByType
• PointElement
• PointOptions
• PointPrefixedOptions
• PolarAreaController
• PolarAreaControllerDatasetOptions
• RadialLinearScale
• Registry
• ScatterDataPoint
• ScriptableLineSegmentContext
• ScriptableTooltipContext
• Tick
• TimeScale
• TooltipCallbacks
• TooltipLabelStyle
• TooltipOptions

AnimationOptions

Type parameters:

Type declaration:

Defined in:

AnimationSpec

Ƭ AnimationSpec<TType>: object

Type parameters:

Type declaration:

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

AnimationsSpec

Ƭ AnimationsSpec<TType>: object

Type parameters:

Type declaration:

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

BarController

Ƭ BarController:

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

BubbleController

Ƭ BubbleController:

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

CategoryScale

Ƭ CategoryScale<O>: <O>

Type parameters:

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

CategoryScaleOptions

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

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

ChartComponentLike

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

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

ChartDataset

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

Type parameters:

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

ChartItem

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

Defined in:

ChartOptions

Ƭ ChartOptions<TType>: DeepPartial<CoreChartOptions<TType> & & PluginChartOptions<TType> & <TType> & ScaleChartOptions<TType> & [TType][chartOptions]>

Type parameters:

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

ChartType

Ƭ ChartType: keyof

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

Color

Ƭ Color: string | CanvasGradient | CanvasPattern

Defined in:

DatasetChartOptions

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

Type parameters:

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

DecimationOptions

Ƭ DecimationOptions: LttbDecimationOptions | MinMaxDecimationOptions

Defined in:

DefaultDataPoint

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

Type parameters:

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

DoughnutDataPoint

Ƭ DoughnutDataPoint: number

Defined in:

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:1443 (opens new window)

FillTarget

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

Defined in:

InteractionMode

Ƭ InteractionMode: keyof InteractionModeMap

Defined in:

InteractionModeFunction

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

Type declaration:

▸ (chart: Chart, e: , options: InteractionOptions, useFinalPosition?: boolean): []

Parameters:

Returns: InteractionItem[]

Defined in:

LayoutPosition

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

Defined in: layout.d.ts:3 (opens new window)

LineController

Ƭ LineController:

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

LinearScale

Ƭ LinearScale<O>: <O>

Type parameters:

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

LinearScaleOptions

Ƭ LinearScaleOptions: & { 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:2858 (opens new window)

LogarithmicScale

Ƭ LogarithmicScale<O>: <O>

Type parameters:

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

LogarithmicScaleOptions

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

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

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

Defined in:

ParsedDataType

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

Type parameters:

Defined in:

PieAnimationOptions

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

PieController

Ƭ PieController:

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

PieControllerChartOptions

Ƭ PieControllerChartOptions:

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

PieControllerDatasetOptions

Ƭ PieControllerDatasetOptions:

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

PieDataPoint

Ƭ PieDataPoint:

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

PointStyle

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

Defined in:

PolarAreaAnimationOptions

Ƭ PolarAreaAnimationOptions: DoughnutAnimationOptions

Defined in:

RadarController

Ƭ RadarController: DatasetController

Defined in:

RadarControllerChartOptions

Ƭ RadarControllerChartOptions: LineControllerChartOptions

Defined in:

RadialLinearScaleOptions

Ƭ RadialLinearScaleOptions: CoreScaleOptions & { angleLines: { borderDash: <number[], ScriptableScaleContext> ; borderDashOffset: <number, ScriptableScaleContext> ; : <Color, > ; display: boolean ; lineWidth: Scriptable<number, > } ; animate: boolean ; beginAtZero: boolean ; grid: GridLineOptions ; max: number ; min: number ; pointLabels: { backdropColor: <Color, > ; backdropPadding: Scriptable<number | , ScriptableScaleContext> ; callback: (label: string, index: number) => string ; color: <Color, > ; display: boolean ; font: Scriptable<, ScriptableScaleContext> } ; suggestedMax: number ; suggestedMin: number ; ticks: & { backdropColor: Scriptable<, ScriptableScaleContext> ; backdropPadding: number | ; count: number ; format: Intl.NumberFormatOptions ; maxTicksLimit: number ; precision: number ; showLabelBackdrop: Scriptable<boolean, > ; stepSize: number } }

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

ScaleChartOptions

Ƭ ScaleChartOptions<TType>: object

Type parameters:

Type declaration:

Defined in:

ScaleOptions

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

Type parameters:

Defined in:

ScaleOptionsByType

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

Type parameters:

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

ScaleType

Ƭ ScaleType: keyof

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

ScatterController

Ƭ ScatterController:

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

ScatterControllerChartOptions

Ƭ ScatterControllerChartOptions:

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

ScatterControllerDatasetOptions

Ƭ ScatterControllerDatasetOptions:

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

Scriptable

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

Type parameters:

Defined in:

ScriptableAndArray

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

Type parameters:

Defined in:

ScriptableAndArrayOptions

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

Type parameters:

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

ScriptableOptions

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

Type parameters:

Defined in:

TextAlign

Ƭ TextAlign: left | center | right

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

TimeScaleOptions

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

Defined in:

TimeSeriesScale

Ƭ TimeSeriesScale<O>: TimeScale<O>

Type parameters:

Defined in:

TimeUnit

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

Defined in: adapters.d.ts:1 (opens new window)

TooltipXAlignment

Ƭ TooltipXAlignment: left | center | right

Defined in:

TooltipYAlignment

Ƭ TooltipYAlignment: top | center | bottom

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

TransitionSpec

Ƭ TransitionSpec<TType>: object

Type parameters:

Type declaration:

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

Ƭ TransitionsSpec<TType>: object

Type parameters:

Type declaration:

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

UpdateMode

Ƭ UpdateMode: keyof typeof

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

ArcElement

Defined in:

BarController

• BarController: ChartComponent & { : }

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

BarElement

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

Defined in:

BubbleController

• BubbleController: ChartComponent & { prototype: }

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

CategoryScale

• CategoryScale: & { prototype: CategoryScale<> }

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

DoughnutController

• DoughnutController: & { prototype: DoughnutController }

Defined in:

Element

• Element: object

Type declaration:

Defined in:

Filler

• Const Filler: Plugin

Defined in:

Interaction

• Const Interaction: object

Type declaration:

Defined in:

Legend

• Const Legend: Plugin

Defined in:

LineController

• LineController: ChartComponent & { prototype: }

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

LineElement

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

Defined in:

LinearScale

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

Defined in:

LogarithmicScale

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

Defined in:

PieController

• PieController: ChartComponent & { prototype: }

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

PointElement

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

Defined in:

PolarAreaController

• PolarAreaController: ChartComponent & { prototype: }

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

RadarController

• RadarController: & { prototype: RadarController }

Defined in:

RadialLinearScale

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

Defined in:

ScatterController

• ScatterController: ChartComponent & { prototype: }

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

Ticks

• Const Ticks: object

Type declaration:

Defined in:

TimeScale

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

Defined in:

TimeSeriesScale

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

Defined in:

Title

• Const Title: Plugin

Defined in:

Tooltip

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

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

_adapters

• Const _adapters: object

Type declaration:

Defined in: adapters.d.ts:61 (opens new window)

defaults

• Const defaults:

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

layouts

• Const layouts: object

Type declaration:

Defined in:

• registerables: readonly ChartComponentLike[]

Defined in:

registry

• Const registry: Registry

Defined in: