Chart.js - v3.0.2

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


    AnimationSpec

    Ƭ AnimationSpec<TType>: object

    Type parameters:

    NameType
    TType

    Type declaration:

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

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


    AnimationsSpec

    Ƭ AnimationsSpec<TType>: object

    Type parameters:

    NameType
    TType

    Type declaration:

    Defined in:


    BarController

    Ƭ BarController:

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


    BubbleController

    Ƭ BubbleController: DatasetController

    Defined in:


    CategoryScale

    Ƭ CategoryScale<O>: <O>

    Type parameters:

    NameTypeDefault
    OCategoryScaleOptions

    Defined in:


    CategoryScaleOptions

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

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


    ChartComponentLike

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

    Defined in:


    ChartDataset

    Ƭ ChartDataset<TType, TData>: DeepPartial<{ [key in ChartType]: object & ChartTypeRegistry[key][“datasetOptions”]}[TType]> & <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:


    ChartOptions

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

    Type parameters:

    NameTypeDefault
    TTypeChartType

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


    ChartType

    Ƭ ChartType: keyof ChartTypeRegistry

    Defined in:


    Color

    Ƭ Color: string | CanvasGradient | CanvasPattern

    Defined in:


    DatasetChartOptions

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

    Type parameters:

    NameTypeDefault
    TTypeChartType

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


    DecimationOptions

    Ƭ DecimationOptions: LttbDecimationOptions | MinMaxDecimationOptions

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


    DefaultDataPoint

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

    Type parameters:

    NameType
    TTypeChartType

    Defined in:


    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:


    FillTarget

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

    Defined in:


    InteractionMode

    Ƭ InteractionMode: keyof

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


    InteractionModeFunction

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

    Type declaration:

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

    Parameters:

    Returns: InteractionItem[]

    Defined in:


    LayoutPosition

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

    Defined in:


    LineController

    Ƭ LineController:

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


    LinearScale

    Ƭ LinearScale<O>: Scale<O>

    Type parameters:

    NameTypeDefault
    OLinearScaleOptions

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


    LinearScaleOptions

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

    Defined in:


    LogarithmicScale

    Ƭ LogarithmicScale<O>: <O>

    Type parameters:

    NameTypeDefault
    OLogarithmicScaleOptions

    Defined in:


    LogarithmicScaleOptions

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

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


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

    Defined in:


    ParsedDataType

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

    Type parameters:

    NameTypeDefault
    TTypeChartType

    Defined in:


    PieAnimationOptions

    Defined in:


    PieController

    Ƭ PieController:

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


    PieControllerChartOptions

    Ƭ PieControllerChartOptions: DoughnutControllerChartOptions

    Defined in:


    PieControllerDatasetOptions

    Ƭ PieControllerDatasetOptions:

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


    PieDataPoint

    Ƭ PieDataPoint: DoughnutDataPoint

    Defined in:


    PointStyle

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

    Defined in:


    PolarAreaAnimationOptions

    Ƭ PolarAreaAnimationOptions:

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


    RadarController

    Ƭ RadarController: DatasetController

    Defined in:


    RadarControllerChartOptions

    Ƭ RadarControllerChartOptions:

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


    RadialLinearScaleOptions

    Ƭ RadialLinearScaleOptions: CoreScaleOptions & { angleLines: { borderDash: <number[], ScriptableScaleContext> ; borderDashOffset: <number, ScriptableScaleContext> ; color: <Color, > ; : 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:2956 (opens new window)


    ScaleChartOptions

    Ƭ ScaleChartOptions<TType>: object

    Type parameters:

    NameTypeDefault
    TTypeChartType

    Type declaration:

    NameType
    scalesobject

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


    ScaleOptions

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

    Type parameters:

    NameTypeDefault
    TScaleScaleType

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


    ScaleOptionsByType

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

    Type parameters:

    NameTypeDefault
    TScaleScaleType

    Defined in:


    ScaleType

    Ƭ ScaleType: keyof

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


    ScatterController

    Ƭ ScatterController: LineController

    Defined in:


    ScatterControllerChartOptions

    Ƭ ScatterControllerChartOptions:

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


    ScatterControllerDatasetOptions

    Ƭ ScatterControllerDatasetOptions: LineControllerDatasetOptions

    Defined in:


    Scriptable

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

    Type parameters:

    Name
    T
    TContext

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


    ScriptableAndArray

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

    Type parameters:

    Name
    T
    TContext

    Defined in: index.esm.d.ts:30API - 图48 (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:29API - 图50 (opens new window)


    TextAlign

    Ƭ TextAlign: left | center | right

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


    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:2865API - 图52 (opens new window)


    TimeSeriesScale

    Ƭ TimeSeriesScale<O>: TimeScale<O>

    Type parameters:

    NameTypeDefault
    OTimeScaleOptions

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


    TimeUnit

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

    Defined in: adapters.d.ts:1API - 图54 (opens new window)


    TooltipXAlignment

    Ƭ TooltipXAlignment: left | center | right

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


    TooltipYAlignment

    Ƭ TooltipYAlignment: top | center | bottom

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


    TransitionSpec

    Ƭ TransitionSpec<TType>: object

    Type parameters:

    NameType
    TType

    Type declaration:

    NameType
    animation<TType>
    animationsAnimationsSpec<TType>

    Defined in:


    Ƭ TransitionsSpec<TType>: object

    Type parameters:

    NameType
    TType

    Type declaration:

    Defined in:


    UpdateMode

    Ƭ UpdateMode: keyof typeof

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

    ArcElement

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


    BarController

    BarController: ChartComponent & { prototype: }

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


    BarElement

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

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


    BubbleController

    BubbleController: ChartComponent & { : }

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


    CategoryScale

    CategoryScale: ChartComponent & { prototype: <CategoryScaleOptions> }

    Defined in:


    DoughnutController

    DoughnutController: & { prototype: DoughnutController }

    Defined in:


    Element

    Element: object

    Type declaration:

    NameType
    prototypeElement<{}, {}>

    Defined in:


    Filler

    Const Filler:

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


    Interaction

    Const Interaction: object

    Type declaration:

    NameType
    modes

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


    Legend

    Const Legend: Plugin

    Defined in:


    LineController

    LineController: & { prototype: LineController }

    Defined in:


    LineElement

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

    Defined in:


    LinearScale

    LinearScale: & { prototype: LinearScale<> }

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


    LogarithmicScale

    LogarithmicScale: ChartComponent & { prototype: <LogarithmicScaleOptions> }

    Defined in:


    PieController

    PieController: & { prototype: DoughnutController }

    Defined in:


    PointElement

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

    Defined in:


    PolarAreaController

    PolarAreaController: & { prototype: PolarAreaController }

    Defined in:


    RadarController

    RadarController: & { prototype: RadarController }

    Defined in:


    RadialLinearScale

    RadialLinearScale: & { prototype: RadialLinearScale<> }

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


    ScatterController

    ScatterController: ChartComponent & { prototype: }

    Defined in: index.esm.d.ts:221 (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: & { prototype: TimeScale<> }

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


    TimeSeriesScale

    TimeSeriesScale: ChartComponent & { prototype: <TimeScaleOptions> }

    Defined in:


    Title

    Const Title:

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


    Tooltip

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

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


    _adapters

    Const _adapters: object

    Type declaration:

    NameType
    _date

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


    defaults

    Const defaults: Defaults

    Defined in:


    layouts

    Const layouts: object

    Type declaration:

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


    Const registerables: readonly []

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


    registry

    Const registry: Registry

    Defined in: