图表配置文档
配置方式
图表配置通过 Markdown 注释的方式添加,格式如下:
配置参数
筛选维度层次关系
图表支持三个层次的筛选维度,从高到低依次为:
-
主筛选维度 (
filterBy→filterLabel)- 最高维度的筛选,如:全球、美国、华北、华南
- 决定查看哪个范围的数据
- 展现形式:下拉框
-
业务分组维度 (
groupBy→category)- 业务层面的分组,如:访客数据、营收数据、线上业务、线下业务
- 决定数据的业务分类
- 展现形式:标签卡
-
数据系列维度 (
colorLegend→type)- 最细粒度的数据系列,如:本周访客、上周访客、本年营收、去年营收
- 决定图表中的线条/柱子的颜色区分
- 展现形式:图例
基础配置
支持的图表类型
-
饼图 (pie)
实心圆形图表,适用于显示各部分占整体的比例关系。
-
环形图 (donut)
中心空心的圆环图表,相比饼图更现代化,可在中心显示总计信息。
-
条形图 (bar)
-
折线图 (line)
-
柱状图 (column)
-
面积图 (area)
-
雷达图 (radar)
-
散点图 (scatter)
-
表格 (table)
-
漏斗图 (funnel)
-
定义列表 (descriptions)
-
卡片列表 (docCards)
将一行 Markdown 表格映射为一张卡片,默认按桌面 2 列、窄屏 1 列栅格布局。 表头按以下别名解析为语义字段(支持「逻辑名 + 中英文括号单位」的宽松匹配):
标签列允许使用半角逗号、分号、竖线、斜杠或全角逗号、分号、顿号分隔多个标签。 可通过
cardColumns控制每行卡片数(默认2,传入1即全宽列表), 通过fieldMap将语义字段显式映射到自定义表头。若注释中无法定位主标题列(即
名称/标题/name/title均未命中且未通过fieldMap.title显式指定),整表会降级为普通 Markdown 表格渲染。 -
四象限图 (quadrant)
按行顺序将表格前 4 行渲染为 2×2 网格,常用于优先级矩阵、技术评估等场景。
- 第 1 列 = 象限标签;
- 第 2 列 = 逗号分隔的条目列表;
- 不足 4 行时自动补空占位。
高级配置示例
1. 多图表配置
2. 带分组的折线图
3. 带标题的图表
3.1 带数据时间的图表
通过 dataTime 参数可以在图表工具栏中显示数据时间:
4. 带图例的图表
图例用于区分不同的数据系列,通过 colorLegend 参数配置:
5. 带业务分组的图表
业务分组用于将数据按不同业务类别分组显示,通过 groupBy 参数配置:
6. 带主筛选的图表
主筛选提供最高维度的数据筛选,通过 filterBy 参数配置:
7. 组合筛选图表
可以同时使用数据系列、业务分组和主筛选:
数据格式要求
-
表格数据
- 必须包含表头
- 数据必须与表头对应
- 数值类型会自动格式化
-
日期数据
- 日期格式会自动排序
- 支持标准日期格式
-
数值数据
- 支持数字格式化
- 支持千分位显示
特殊功能
-
图表切换
- 支持在图表类型之间切换
- 切换时会保持数据不变
-
图表配置
- 支持动态修改X轴和Y轴字段
- 支持自定义图表高度
- 支持图表标题设置
-
响应式布局
- 支持多列布局
- 自动适应容器宽度
- 最小宽度为256px
完整示例
注意事项
- 配置必须放在表格之前
- 配置必须是有效的JSON格式
- 表格数据必须与配置的字段对应
- 日期类型的数据会自动排序
- 数值类型的数据会自动格式化
- 图表支持全屏显示
- 支持数据导出为CSV格式
- 支持图表的拖拽和编辑功能
