Chart.js - v3.2.1

    Classes

    Interfaces

    AnimationOptions

    Type parameters:

    Type declaration:

    NameType
    animationfalse | <TType> & { onComplete?: (this: Chart, event: ) => void ; onProgress?: (this: Chart, event: ) => void }
    animationsAnimationsSpec<TType>
    transitions<TType>

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

    AnimationSpec

    Ƭ AnimationSpec<TType>: object

    Type parameters:

    NameType
    TType

    Type declaration:

    NameTypeDescription
    delay?Scriptable<number, <TType>>Delay before starting the animations. default 0
    duration?Scriptable<number, <TType>>The number of milliseconds an animation takes. default 1000
    easing?Scriptable<, ScriptableContext<TType>>Easing function to use default ‘easeOutQuart’
    loop?<boolean, ScriptableContext<TType>>If set to true, the animations loop endlessly. default false

    Defined in:

    AnimationsSpec

    Ƭ AnimationsSpec<TType>: object

    Type parameters:

    NameType
    TTypeChartType

    Type declaration:

    Defined in:

    BarController

    Ƭ BarController: DatasetController

    Defined in:

    BubbleController

    Ƭ BubbleController: DatasetController

    Defined in:

    CategoryScale

    Ƭ CategoryScale<O>: Scale<O>

    Type parameters:

    NameTypeDefault
    OCategoryScaleOptions

    Defined in:

    CategoryScaleOptions

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

    Defined in:

    ChartComponentLike

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

    Defined in:

    ChartDataset

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

    Type parameters:

    NameTypeDefault
    TTypeChartType
    TData-TType[]

    Defined in:

    ChartItem

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

    Defined in: index.esm.d.ts:506API - 图1 (opens new window)

    ChartOptions

    Ƭ ChartOptions<TType>: DeepPartial<<TType> & ElementChartOptions<TType> & <TType> & DatasetChartOptions<TType> & <TType> & ChartTypeRegistry[TType][chartOptions]>

    Type parameters:

    NameTypeDefault
    TTypeChartType

    Defined in:

    ChartType

    Ƭ ChartType: keyof ChartTypeRegistry

    Defined in:

    Color

    Ƭ Color: string | CanvasGradient | CanvasPattern

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

    DatasetChartOptions

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

    Type parameters:

    NameTypeDefault
    TTypeChartType

    Defined in:

    DecimationOptions

    Ƭ DecimationOptions: LttbDecimationOptions | MinMaxDecimationOptions

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

    DefaultDataPoint

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

    Type parameters:

    NameType
    TTypeChartType

    Defined in:

    DoughnutDataPoint

    Ƭ DoughnutDataPoint: number

    Defined in: index.esm.d.ts:300 (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:

    ElementChartOptions

    Ƭ ElementChartOptions<TType>: object

    Type parameters:

    NameTypeDefault
    TTypeChartType

    Type declaration:

    Defined in: index.esm.d.ts:1897 (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:

    NameType
    chartChart
    e
    optionsInteractionOptions
    useFinalPosition?boolean

    Returns: []

    Defined in: index.esm.d.ts:663API - 图2 (opens new window)

    LayoutPosition

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

    Defined in:

    LineController

    Ƭ LineController: DatasetController

    Defined in:

    LinearScale

    Ƭ LinearScale<O>: Scale<O>

    Type parameters:

    NameTypeDefault
    OLinearScaleOptions

    Defined in:

    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:

    LogarithmicScale

    Ƭ LogarithmicScale<O>: Scale<O>

    Type parameters:

    NameTypeDefault
    OLogarithmicScaleOptions

    Defined in:

    LogarithmicScaleOptions

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

    Defined in:

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

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

    ParsedDataType

    Type parameters:

    NameTypeDefault
    TTypeChartType

    Defined in:

    PieAnimationOptions

    Ƭ PieAnimationOptions: DoughnutAnimationOptions

    Defined in:

    PieController

    Ƭ PieController: DoughnutController

    Defined in:

    PieControllerChartOptions

    Ƭ PieControllerChartOptions: DoughnutControllerChartOptions

    Defined in:

    PieControllerDatasetOptions

    Ƭ PieControllerDatasetOptions: DoughnutControllerDatasetOptions

    Defined in:

    PieDataPoint

    Ƭ PieDataPoint: DoughnutDataPoint

    Defined in:

    PointStyle

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

    Defined in: index.esm.d.ts:1734API - 图3 (opens new window)

    PolarAreaAnimationOptions

    Ƭ PolarAreaAnimationOptions:

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

    RadarController

    Ƭ RadarController:

    Defined in: index.esm.d.ts:386API - 图4 (opens new window)

    RadarControllerChartOptions

    Ƭ RadarControllerChartOptions:

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

    RadialLinearScaleOptions

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

    Defined in:

    ScaleChartOptions

    Ƭ ScaleChartOptions<TType>: object

    Type parameters:

    NameTypeDefault
    TTypeChartType

    Type declaration:

    NameType
    scalesobject

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

    ScaleOptions

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

    Type parameters:

    NameTypeDefault
    TScaleScaleType

    Defined in: index.esm.d.ts:3309API - 图5 (opens new window)

    ScaleOptionsByType

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

    Type parameters:

    NameTypeDefault
    TScaleScaleType

    Defined in:

    ScaleType

    Ƭ ScaleType: keyof ScaleTypeRegistry

    Defined in:

    ScatterController

    Ƭ ScatterController: LineController

    Defined in:

    ScatterControllerChartOptions

    Ƭ ScatterControllerChartOptions: LineControllerChartOptions

    Defined in:

    ScatterControllerDatasetOptions

    Ƭ ScatterControllerDatasetOptions: LineControllerDatasetOptions

    Defined in:

    Scriptable

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

    Type parameters:

    Name
    T
    TContext

    Defined in: index.esm.d.ts:34API - 图6 (opens new window)

    ScriptableAndArray

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

    Type parameters:

    Name
    T
    TContext

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

    ScriptableAndArrayOptions

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

    Type parameters:

    Defined in:

    ScriptableOptions

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

    Type parameters:

    Name
    T
    TContext

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

    TextAlign

    Ƭ TextAlign: left | center | right

    Defined in:

    TimeScaleOptions

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

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

    TimeSeriesScale

    Ƭ TimeSeriesScale<O>: <O>

    Type parameters:

    NameTypeDefault
    OTimeScaleOptions

    Defined in: index.esm.d.ts:3040API - 图7 (opens new window)

    TimeUnit

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

    Defined in:

    TooltipXAlignment

    Ƭ TooltipXAlignment: left | center | right

    Defined in: index.esm.d.ts:2254API - 图8 (opens new window)

    TooltipYAlignment

    Ƭ TooltipYAlignment: top | center | bottom

    Defined in:

    TransitionSpec

    Ƭ TransitionSpec<TType>: object

    Type parameters:

    NameType
    TTypeChartType

    Type declaration:

    NameType
    animation<TType>
    animationsAnimationsSpec<TType>

    Defined in:

    TransitionsSpec

    Ƭ TransitionsSpec<TType>: object

    Type parameters:

    NameType
    TTypeChartType

    Type declaration:

    Defined in:

    Defined in: index.esm.d.ts:525API - 图9 (opens new window)

    ArcElement

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

    Defined in:

    BarController

    • BarController: ChartComponent & { prototype: }

    Defined in: index.esm.d.ts:140API - 图10 (opens new window)

    BarElement

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

    Defined in:

    BubbleController

    • BubbleController: ChartComponent & { prototype: }

    Defined in: index.esm.d.ts:168API - 图11 (opens new window)

    CategoryScale

    • CategoryScale: & { prototype: CategoryScale<> }

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

    DoughnutController

    • DoughnutController: & { prototype: DoughnutController }

    Defined in:

    Element

    • Element: object

    Type declaration:

    NameType
    prototypeElement<{}, {}>

    Defined in:

    Filler

    • Const Filler: Plugin

    Defined in:

    Interaction

    • Const Interaction: object

    Type declaration:

    NameType
    modesInteractionModeMap

    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:227API - 图12 (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:

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

    _adapters

    • Const _adapters: object

    Type declaration:

    NameType
    _date

    Defined in: adapters.d.ts:61API - 图13 (opens new window)

    defaults

    • Const defaults:

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

    layouts

    • Const layouts: object

    Type declaration:

    NameType
    addBox(chart: <bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | )[], unknown>, item: LayoutItem) => void
    configure(chart: <bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | )[], unknown>, item: LayoutItem, options: { fullSize?: number ; position?: ; weight?: number }) => void
    removeBox(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | | BubbleDataPoint)[], unknown>, layoutItem: ) => void
    update(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | | BubbleDataPoint)[], unknown>, width: number, height: number) => void

    Defined in:

    registerables

    • Const registerables: readonly ChartComponentLike[]

    Defined in:

    registry

    Defined in: index.esm.d.ts:1060API - 图14 (opens new window)