# 接口:默认值

# 层次结构

# 属性

# 动画

animation: false | AnimationSpec<keyof ChartTypeRegistry> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint][], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint][], unknown>, event: AnimationEvent) => void }

# 继承自

CoreChartOptions.animation

# 定义于

types/index.d.ts:1747 (在新窗口打开)


# 动画

animations: AnimationsSpec<keyof ChartTypeRegistry>

# 继承自

CoreChartOptions.animations

# 定义于

types/index.d.ts:1757 (在新窗口打开)


# 宽高比

aspectRatio: number

画布宽高比(即宽度/高度,值为1表示正方形画布)。注意,如果显式地指定了高度(作为属性或样式),则此选项将被忽略。

默认值

2

# 继承自

CoreChartOptions.aspectRatio

# 定义于

types/index.d.ts:1645 (在新窗口打开)


# 背景颜色

背景颜色: Scriptable<Color, ScriptableContext<keyof ChartTypeRegistry>>

基本背景颜色

查看

默认值.backgroundColor

# 继承自

CoreChartOptions.backgroundColor

# 定义于

types/index.d.ts:1614 (在新窗口中打开)


# 边框颜色

边框颜色: Scriptable<Color, ScriptableContext<keyof ChartTypeRegistry>>

基本边框颜色

查看

默认值.borderColor

# 继承自

CoreChartOptions.borderColor

# 定义于

types/index.d.ts:1619 (在新窗口中打开)


# 剪裁

剪裁: number | false | ChartArea

相对于chartArea的剪裁方式。正值允许溢出,负值剪切到chartArea内部这么多像素。0 = 在chartArea处剪切。也可以按边配置剪裁:clip: {left: 5, top: false, right: -2, bottom: 0}

# 继承自

CoreChartOptions.clip

# 定义于

types/index.d.ts:1603 (在新窗口中打开)


# 颜色

颜色: Scriptable<Color, ScriptableContext<keyof ChartTypeRegistry>>

基本颜色

查看

默认值.color

# 继承自

CoreChartOptions.color

# 定义于

types/index.d.ts:1609 (在新窗口中打开)


# 数据集

数据集: Object

# 类型声明

名称 类型
柱状图 BarControllerDatasetOptions
气泡图 BubbleControllerDatasetOptions
饼图 DoughnutControllerDatasetOptions
折线图 LineControllerDatasetOptions & FillerControllerDatasetOptions
饼图 DoughnutControllerDatasetOptions
极坐标面积图 PolarAreaControllerDatasetOptions
雷达图 RadarControllerDatasetOptions & FillerControllerDatasetOptions
散点图 LineControllerDatasetOptions

# 继承自

CoreChartOptions.datasets

# 定义于

types/index.d.ts:1590 (在新窗口中打开)


# devicePixelRatio

devicePixelRatio: number

覆盖窗口的默认devicePixelRatio。

默认值

window.devicePixelRatio

# 继承自

CoreChartOptions.devicePixelRatio

# 定义于

types/index.d.ts:1662 (在新窗口中打开)


# elements

elements: ElementOptionsByType<keyof ChartTypeRegistry>

# 继承自

ElementChartOptions.elements

# 定义于

types/index.d.ts:2137 (在新窗口中打开)


# events

events: keyof HTMLElementEventMap[]

events选项定义了图表应监听哪些浏览器事件以用于工具提示和悬停。

默认值

['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']

# 继承自

CoreChartOptions.events

# 定义于

types/index.d.ts:1672 (在新窗口中打开)


# font

font: Partial<FontSpec>

基础字体

查看

Defaults.font

# 继承自

CoreChartOptions.font

# 定义于

types/index.d.ts:1624 (在新窗口中打开)


# hover

hover: CoreInteractionOptions

# 继承自

CoreChartOptions.hover

# 定义于

types/index.d.ts:1666 (在新窗口中打开)


# indexAxis

indexAxis: "x" | "y"

图表的基础轴线。'x' 用于垂直图表,'y' 用于水平图表。

默认值

'x'

# 继承自

CoreChartOptions.indexAxis

# 定义于

types/index.d.ts:1598 (在新窗口中打开)


# interaction

interaction: CoreInteractionOptions

# 继承自

CoreChartOptions.interaction

# 定义于

types/index.d.ts:1664 (在新窗口中打开)


# layout

layout: Partial<{ autoPadding: boolean ; padding: Scriptable<Padding, ScriptableContext<keyof ChartTypeRegistry>> }>

# 继承自

CoreChartOptions.layout

# 定义于

types/index.d.ts:1684 (在新窗口中打开)


# locale

locale: string

用于数字格式化的地区设置(使用 Intl.NumberFormat)。

默认值

浏览器的用户设置

# 继承自

CoreChartOptions.locale

# 定义于

types/index.d.ts:1651 (在新窗口中打开)


# maintainAspectRatio

maintainAspectRatio: boolean

在调整大小时保持原始画布的宽高比(宽度/高度)。为此选项正确工作,图表必须在其自己的专用容器中。

默认值

true

# 继承自

CoreChartOptions.maintainAspectRatio

# 定义在

types/index.d.ts:1634 (在新窗口中打开)


# normalized

normalized: boolean

如果提供的数据具有唯一、排序一致且跨数据集一致的索引,则Chart.js运行最快。通过提供normalized: true选项让Chart.js知道您已这样做。

# 继承自

CoreChartOptions.normalized

# 定义在

types/index.d.ts:63 (在新窗口中打开)


# parsing

parsing: false | { [key: string]: string; }

如何解析数据集。可以通过在图表选项或数据集中指定parsing: false来禁用解析。如果禁用解析,则数据必须排序,并且采用与相关图表类型和刻度内部使用的格式。

# 继承自

CoreChartOptions.parsing

# 定义在

types/index.d.ts:54 (在新窗口中打开)


# plugins

plugins: PluginOptionsByType<keyof ChartTypeRegistry>

# 继承自

PluginChartOptions.plugins

# 定义在

types/index.d.ts:2950 (在新窗口中打开)


# resizeDelay

resizeDelay: number

通过指定的毫秒数延迟调整大小更新。这可以通过防抖更新元素来简化调整大小过程。

默认值

0

# 继承自

CoreChartOptions.resizeDelay

# 定义于

types/index.d.ts:1639 (在新窗口中打开)


# responsive

responsive: boolean

在其容器调整大小时调整图表画布的大小(重要注意事项……)。

默认值

true

# 继承自

CoreChartOptions.responsive

# 定义于

types/index.d.ts:1629 (在新窗口中打开)


# scale

scale: ScaleOptionsByType<keyof ScaleTypeRegistry>

# 定义于

types/index.d.ts:668 (在新窗口中打开)


# scales

scales: Object

# 类型声明

名称 类型
category { type: "category" } & Omit<CartesianScaleOptions, "max" | "min"> & { labels: string[] | string[][] ; max: string | number ; min: string | number }
linear { type: "linear" } & CartesianScaleOptions & { beginAtZero: boolean ; grace?: string | number ; suggestedMax?: number ; suggestedMin?: number ; ticks: { count: number ; format: NumberFormatOptions ; precision: number ; stepSize: number } }
logarithmic { type: "logarithmic" } & CartesianScaleOptions & { suggestedMax?: number ; suggestedMin?: number ; ticks: { format: NumberFormatOptions } }
radialLinear { type: "radialLinear" } 与 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 | number | string[] | 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 }
时间 { type: "time" } 与 Omit<CartesianScaleOptions, "max" | "min"> 以及 { adapters: { date: unknown } ; bounds: "data" | "ticks" ; max: string | number ; min: string | number ; offsetAfterAutoskip: boolean ; suggestedMax: string | number ; suggestedMin: string | number ; ticks: TimeScaleTickOptions ; time: TimeScaleTimeOptions }
时间序列 { type: "timeseries" } 与 Omit<CartesianScaleOptions, "max" | "min"> 以及 { adapters: { date: unknown } ; bounds: "data" | "ticks" ; max: string | number ; min: string | number ; offsetAfterAutoskip: boolean ; suggestedMax: string | number ; suggestedMin: string | number ; ticks: TimeScaleTickOptions ; time: TimeScaleTimeOptions }

# 定义于

types/index.d.ts:669 (在新窗口中打开)


# 状态转变

状态转变: TransitionsSpec<keyof ChartTypeRegistry>

# 继承自

CoreChartOptions.状态转变

# 定义于

types/index.d.ts:1758 (在新窗口中打开)

# 方法

# describe

describe(scope, values): AnyObject

# 参数

名称 类型
scope string
values AnyObject

# 返回

AnyObject

# 定义于

types/index.d.ts:677 (在新窗口中打开)


# get

get(scope): AnyObject

# 参数

名称 类型
scope string

# 返回

AnyObject

# 定义于

types/index.d.ts:675 (在新窗口中打开)


# onClick

onClick(event, elements, chart): void

在事件类型为 'mouseup' 或 'click' 时被调用。传递事件、活动元素数组以及图表。

# 参数

名称 类型
event ChartEvent
elements ActiveElement[]
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# 返回

void

# 继承自

CoreChartOptions.onClick

# 定义于

types/index.d.ts:1682 (在新窗口中打开)


# onHover

onHover(event, elements, chart): void

当任何事件触发时被调用。传递事件、活动元素数组(条形、点等)以及图表。

# 参数

名称 类型
event ChartEvent
elements ActiveElement[]
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# 返回值

void

# 继承自

CoreChartOptions.onHover

# 定义于

types/index.d.ts:1677 (opens new window)


# onResize

onResize(chart, size): void

当发生尺寸变化时被调用。接受两个参数:图表实例和新尺寸。

# 参数

名称 类型
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
size Object
size.height number
size.width number

# 返回值

void

# 继承自

CoreChartOptions.onResize

# 定义于

types/index.d.ts:1656 (opens new window)


# override

override(scope, values): AnyObject

# 参数

名称 类型
scope string
values AnyObject

# 返回值

AnyObject

# 定义于

types/index.d.ts:678 (opens new window)


# route

route(scope, name, targetScope, targetName): void

将名称路由重定向到其他作用域/名称。这种路由在目标值(如 defaults.color)在运行时改变时很有用。如果复制值,则运行时更改不会生效。通过路由,回退在每次访问时都会被评估,因此总是最新的。

示例

defaults.route('elements.arc', 'backgroundColor', '', 'color')

  • 在本地未定义时读取 defaults.color 的 backgroundColor

# 参数

名称 类型 描述
scope string 此路由应用的作用域。
name string 应将其路由到不同命名空间(当未在此处定义时)的属性名称。
targetScope string 目标属性应路由到的命名空间。空字符串 ('') 是 defaults 的根。
targetName string 目标作用域中属性的名称。

# 返回值

void

# 定义于

types/index.d.ts:697 (opens new window)


# set

set(values): AnyObject

# 参数

名称 类型
values AnyObject

# 返回值

AnyObject

# 定义于

types/index.d.ts:673 (在新窗口中打开)

设置(作用域, ): AnyObject

# 参数

名称 类型
scope string
values AnyObject

# 返回值

AnyObject

# 定义于

types/index.d.ts:674 (在新窗口中打开)