数据

每列都有 id、label 和 role。role: 'label' 表示用于命名各行的列，role: 'series' 表示数值列。每一行都是一个单元格列表，每列对应一个单元格。

数据来源

绘制哪些列

图表数据会保留所有列。图表设置中的 encoding 字段记录图表在编辑器和导出内容中要绘制的列 ID：

• 未指定 label 时，role: 'label' 的列用于命名各行。
• 未指定 series 时，会绘制其他所有 role: 'series' 的列。
• 如果某个 ID 不在数据中，就会被忽略。因此，即使数据源重命名了列，图表仍可继续绘制。
• 如果 series 中的 ID 一个也不在数据中，则会绘制所有系列。
• 同步会替换所有列，同时保留 encoding。参见数据源。

可通过 updateChartSpec 或下列命令设置 encoding。

命令

updateChartData

替换图表数据。

editor.commands.updateChartData({ data })

如果 pos 处或当前选区中没有图表，或者图表关联的数据源为只读且新数据与当前数据不同，则返回 false。

setChartLabelColumn

指定用于命名各行的列。encoding.series 将设为图表类型可绘制的其他列。

editor.commands.setChartLabelColumn({ label: 'region' })

大多数图表类型会绘制 role: 'series' 的列。对于按 matrix 结构读取数据的类型（例如 matrix 图表），会绘制所有列。参见注册自定义图表类型。选择第一列会从 encoding 中移除 label 和 series；encoding.seriesIn 始终保留。

如果指定的列 ID 不存在于数据中，则返回 false。

setChartSeriesIn

指定图表系列按列还是按行读取。一个系列是一组要绘制的值，例如一条线或一种颜色的柱形。

editor.commands.setChartSeriesIn({ seriesIn: 'rows' })

设为 'rows' 后，每一行都会成为一个以行标签命名的系列，每个要绘制的列都会成为一个类别。以下面的柱状图数据为例：

Month | Visitors
Jan   | 120
Feb   | 150
Mar   | 170

此命令只会更改 spec.encoding.seriesIn，并保留 label 和 series。交换后，spec.series 中的样式按行标签指定，spec.palette 则按绘制顺序为系列着色。

updateChartFrom

根据已注册格式的内容替换图表数据和规格。可将图表读为图表语法、图表 JSON 或 Mermaid 文本，修改后再写回：

editor.commands.updateChartFrom({ format: 'chart-syntax', content: 'Jan | 2\nFeb | 3' })

当内容无法读取或图表为只读时，返回 false。

updateChartFromGrid

替换字符串网格中的数据。

editor.commands.updateChartFromGrid({ grid })

可与 readGrid 配合使用，将数据作为表单字段编辑。粘贴到选中图表上的电子表格行也会通过此命令更新数据，参见粘贴到选中的图表。

在与 updateChartData 相同的情况下返回 false。

updateChartFromTable

替换表 JSON 中的数据。

editor.commands.updateChartFromTable({ table })

将其与 readTable 一起使用，这会以表 JSON 形式返回图表数据。

在与 updateChartData 相同的情况下返回 false。

工具帮助程序

来自 @tiptap-pro/extension-diagrams/core：