ECharts 入门教程 ECharts grid组件配置提示框浮层内容格式器

2024-02-25 开发教程 ECharts 入门教程匿名 13℃

grid.tooltip.formatter | string, Function

提示框浮层内容格式器，支持字符串模板和回调函数两种形式。

1 字符串模板

模板变量有 {a}, {b}，{c}，{d}，{e}，分别表示系列名，数据名，数据值等。在 trigger为 'axis' 的时候，会有多个系列的数据，此时可以通过 {a0}, {a1}, {a2} 这种后面加索引的方式表示系列的索引。不同图表类型下的 {a}，{b}，{c}，{d} 含义不一样。其中变量{a}, {b}, {c}, {d}在不同图表类型下代表数据含义为：

折线（区域）图、柱状（条形）图、K线图 : {a}（系列名称），{b}（类目值），{c}（数值）, {d}（无）
散点图（气泡）图 : {a}（系列名称），{b}（数据名称），{c}（数值数组）, {d}（无）
地图 : {a}（系列名称），{b}（区域名称），{c}（合并数值）, {d}（无）
饼图、仪表盘、漏斗图: {a}（系列名称），{b}（数据项名称），{c}（数值）, {d}（百分比）

更多其它图表模板变量的含义可以见相应的图表的 label.normal.formatter 配置项。

示例：

formatter: '{b0}: {c0}<br />{b1}: {c1}'

2 回调函数

回调函数格式：

(params: Object|Array, ticket: string, callback: (ticket: string, html: string)) => string

第一个参数 params 是 formatter 需要的数据集。格式如下：

{
    componentType: 'series',
    // 系列类型
    seriesType: string,
    // 系列在传入的 option.series 中的 index
    seriesIndex: number,
    // 系列名称
    seriesName: string,
    // 数据名，类目名
    name: string,
    // 数据在传入的 data 数组中的 index
    dataIndex: number,
    // 传入的原始数据项
    data: Object,
    // 传入的数据值
    value: number|Array,
    // 数据图形的颜色
    color: string,
    // 饼图的百分比
    percent: number,
    //
    galleryViewPath: ,
    //
     galleryEditorPath: ,
    //
     imagePath: ,
    //
     gl: ,
}

在 trigger为 'axis' 的时候，或者 tooltip 被 axisPointer触发的时候，params 是多个系列的数据数组。其中每项内容格式同上，并且：

{
    componentType: 'series',
    // 系列类型
    seriesType: string,
    // 系列在传入的 option.series 中的 index
    seriesIndex: number,
    // 系列名称
    seriesName: string,
    // 数据名，类目名
    name: string,
    // 数据在传入的 data 数组中的 index
    dataIndex: number,
    // 传入的原始数据项
    data: Object,
    // 传入的数据值
    value: number|Array,
    // 数据图形的颜色
    color: string,
}

注： ECharts 2.x 使用数组表示各参数的方式不再支持。

第二个参数 ticket 是异步回调标识，配合第三个参数 callback 使用。第三个参数 callback 是异步回调，在提示框浮层内容是异步获取的时候，可以通过 callback 传入上述的 ticket 和 html 更新提示框浮层内容。

示例：

formatter: function (params, ticket, callback) {
    $.get('detail?name=' + params.name, function (content) {
        callback(ticket, toHTML(content));
    });
    return 'Loading';
}

上一节： ECharts grid组件配置提示框浮层的位置

下一节： ECharts grid组件配置提示框浮层背景色、边框及内边距

"ECharts 入门教程"的目录

ECharts 入门教程 ECharts grid组件配置 提示框浮层内容格式器

ECharts 入门教程 ECharts grid组件配置提示框浮层内容格式器