Chart.js

# 接口: BarControllerDatasetOptions

# 层次结构

# 属性

# animation

• animation: false | AnimationSpec<"bar"> & { 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 }

# 继承自

AnimationOptions.animation

# 定义于

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

# animations

• animations: AnimationsSpec<"bar">

# 继承自

AnimationOptions.animations

# 定义于

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

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"bar">>

# 继承自

ScriptableAndArrayOptions.backgroundColor

# 定义于

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

# barPercentage

• barPercentage: number

每个柱状图在类别宽度内可用的宽度百分比（0-1）。1.0 将占用整个类别宽度，并将柱状图彼此紧挨着放置。

默认

0.9

# 定义于

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

# barThickness

• barThickness: number | "flex"

手动设置每个柱状图的宽度（以像素为单位）。如果设置为 'flex'，它将计算全局排列的柱状图的“最佳”样本宽度。如果未设置（默认），柱状图的尺寸将根据最小的间隔来确定。

# 定义于

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

# base

• base: ScriptableAndArray<number, ScriptableContext<"bar">>

柱状图在数值轴上的数据单位中的基准值。

# 继承自

ScriptableAndArrayOptions.base

# 定义于

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

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"bar">>

# 继承自

ScriptableAndArrayOptions.borderColor

# 定义于

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

# borderRadius

• borderRadius: ScriptableAndArray<number | BorderRadius, ScriptableContext<"bar">>

圆角

默认

0

# 继承自

ScriptableAndArrayOptions.borderRadius

# 定义于

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

# borderSkipped

• borderSkipped: ScriptableAndArray<boolean | "end" | "start" | "left" | "top" | "bottom" | "right" | "middle", ScriptableContext<"bar">>

跳过（排除）的边框：'start'、'end'、'left'、'right'、'bottom'、'top'、'middle'、false（无）或 true（全部）。

默认

'start'

# 继承自

ScriptableAndArrayOptions.borderSkipped

# 定义于

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

# borderWidth

• borderWidth: ScriptableAndArray<number | { bottom?: number ; left?: number ; right?: number ; top?: number }, ScriptableContext<"bar">>

边框宽度，数字表示所有边框的宽度，对象表示每个边框的宽度。

默认

0

# 继承自

ScriptableAndArrayOptions.borderWidth

# 定义于

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

# categoryPercentage

• categoryPercentage: number

每个类别在样本宽度内占用的可用宽度的百分比（0-1）。

默认

0.8

# 定义于

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

# clip

• clip: number | false | ChartArea

相对于 chartArea 的裁剪方式。正值表示允许溢出，负值表示在 chartArea 内裁剪那么多像素。0 = 在 chartArea 处裁剪。裁剪也可以针对每个边框进行配置：clip: {left: 5, top: false, right: -2, bottom: 0}

# 继承自

ControllerDatasetOptions.clip

# 定义于

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

# grouped

• grouped: boolean

柱形图是否应在索引轴上分组。

默认

true

# 定义于

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

# hidden

• hidden: boolean

配置数据集的可见性状态。将其设置为 true，以从图表中隐藏数据集。

默认

false

# 继承自

ControllerDatasetOptions.hidden

# 定义于

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

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"bar">>

# 继承自

ScriptableAndArrayOptions.hoverBackgroundColor

# 定义于

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

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"bar">>

# 继承自

ScriptableAndArrayOptions.hoverBorderColor

# 定义于

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

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"bar">>

# 继承自

ScriptableAndArrayOptions.hoverBorderWidth

# 定义于

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

# indexAxis

• indexAxis: "x" | "y"

图表的基准轴。垂直图表为 'x'，水平图表为 'y'。

默认

'x'

# 继承自

ControllerDatasetOptions.indexAxis

# 定义于

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

# inflateAmount

• inflateAmount: ScriptableAndArray<number | "auto", ScriptableContext<"bar">>

矩形膨胀量。这可用于隐藏柱形图之间的伪影。单位为像素。'auto' 在 barPercentage * categoryPercentage 为 1 时转换为 0.33 像素，否则为 0。

默认

'auto'

# 继承自

ScriptableAndArrayOptions.inflateAmount

# 定义于

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

# label

• label: string

数据集的标签，显示在图例和工具提示中。

# 继承自

ControllerDatasetOptions.label

# 定义于

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

# maxBarThickness

• maxBarThickness: number

设置此选项以确保柱形图的宽度不超过此值。

# 定义于

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

# minBarLength

• minBarLength: number

设置此选项以确保柱形图的最小长度（以像素为单位）。

# 定义于

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

# normalized

• normalized: boolean

如果您提供具有唯一、排序且在数据集之间一致的索引的数据，并且提供了 normalized: true 选项来让 Chart.js 知道您已经这样做，Chart.js 的速度最快。

# 继承自

ControllerDatasetOptions.normalized

# 定义于

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

# order

• order: number

数据集的绘制顺序。也影响堆叠、提示和图例的顺序。

# 继承自

ControllerDatasetOptions.order

# 定义于

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

# 解析

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

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

# 继承自

ControllerDatasetOptions.parsing

# 定义于

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

# pointStyle

• pointStyle: PointStyle

图例的点样式

默认

'circle;

# 定义于

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

# stack

• stack: string

此数据集所属组的 ID（当堆叠时，每个组将是一个单独的堆叠）。

# 继承自

ControllerDatasetOptions.stack

# 定义于

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

# transitions

• transitions: TransitionsSpec<"bar">

# 继承自

AnimationOptions.transitions

# 定义于

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

# xAxisID

• xAxisID: string

绘制此数据集的 x 轴的 ID。

# 定义于

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

# yAxisID

• yAxisID: string

绘制此数据集的 y 轴的 ID。

# 定义于

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

← BarElement →