diff --git a/docs/zh-CN/components/chart.md b/docs/zh-CN/components/chart.md index d90006035..f1e4408bd 100755 --- a/docs/zh-CN/components/chart.md +++ b/docs/zh-CN/components/chart.md @@ -304,7 +304,7 @@ api 返回支持两种格式,一种是直接返回完整 echarts 配置,数 "body": [ { "type": "tpl", - "tpl": "当前选中值 ${value|json}" + "tpl": "

当前选中值 ${value|json}

seriesType ${seriesType}

seriesIndex ${seriesIndex}

seriesName ${seriesName}

name ${name}

dataIndex ${dataIndex}

" }, { "type": "chart", @@ -316,6 +316,36 @@ api 返回支持两种格式,一种是直接返回完整 echarts 配置,数 } ``` +具体能拿到的参数请参考 [Echarts](https://echarts.apache.org/handbook/zh/concepts/event#%E9%BC%A0%E6%A0%87%E4%BA%8B%E4%BB%B6%E7%9A%84%E5%A4%84%E7%90%86) 的文档,官方定义如下 + +```typescript +type EventParams = { + // 当前点击的图形元素所属的组件名称, + // 其值如 'series'、'markLine'、'markPoint'、'timeLine' 等。 + componentType: string; + // 系列类型。值可能为:'line'、'bar'、'pie' 等。当 componentType 为 'series' 时有意义。 + seriesType: string; + // 系列在传入的 option.series 中的 index。当 componentType 为 'series' 时有意义。 + seriesIndex: number; + // 系列名称。当 componentType 为 'series' 时有意义。 + seriesName: string; + // 数据名,类目名 + name: string; + // 数据在传入的 data 数组中的 index + dataIndex: number; + // 传入的原始数据项 + data: Object; + // sankey、graph 等图表同时含有 nodeData 和 edgeData 两种 data, + // dataType 的值会是 'node' 或者 'edge',表示当前点击在 node 还是 edge 上。 + // 其他大部分图表中只有一种 data,dataType 无意义。 + dataType: string; + // 传入的数据值 + value: number | Array; + // 数据图形的颜色。当 componentType 为 'series' 时有意义。 + color: string; +}; +``` + ## 远程拉取动态配置项 配置`api`,来远程拉取图标配置