提示框组件属性

本章是专门为您讲解 ECharts 图表的提示框组件 tooltip 的一些基本的属性设置，一下是有关于提示框组件的通用介绍：

提示框组件可以设置在多种地方：

可以设置在全局，即 tooltip
可以设置在坐标系中，即 grid.tooltip、polar.tooltip、single.tooltip
可以设置在系列中，即 series.tooltip
可以设置在系列的每个数据项中，即 series.data.tooltip

boolean [ 默认值: true ]

是否显示提示框组件，包括提示框浮层和 axisPointer。

tooltip.trigger

string [ 默认值: 'item' ]

提示框组件的触发类型。

可选：

'item'：数据项图形触发，主要在散点图，饼图等无类目轴的图表中使用。
'axis'：坐标轴触发，主要在柱状图，折线图等会使用类目轴的图表中使用。在 ECharts 2.x 中只支持类目轴上使用 axis trigger，在 ECharts 3 中支持在直角坐标系和极坐标系上的所有类型的轴。并且可以通过 axisPointer.axis 指定坐标轴。
'none'：什么都不触发。

boolean [ 默认值: true ]

是否显示提示框浮层，默认显示。只需 tooltip 触发事件或显示 axisPointer 而不需要显示内容时可配置该项为 false。

boolean [ 默认值: false ]

是否永远显示提示框内容，默认情况下在移出可触发提示框区域后一定时间后隐藏，设置为 true 可以保证一直显示提示框内容。

该属性为 ECharts 3.0 中新加。

tooltip.triggerOn

string [ 默认值: 'mousemove|click' ]

提示框触发的条件，可选：

'mousemove'：鼠标移动时触发。
'click'：鼠标点击时触发。
'mousemove|click'：同时鼠标移动和点击时触发。
'none':不在 'mousemove' 或 'click' 时触发，用户可以通过 action.tooltip.showTip 和 action.tooltip.hideTip 来手动触发和隐藏。也可以通过 axisPointer.handle 来触发或隐藏。该属性为 ECharts 3.0 中新加。

number [ 默认值: 0 ]

浮层显示的延迟，单位为 ms，默认没有延迟，也不建议设置。在 triggerOn 为 'mousemove' 时有效。

number [ 默认值: 100 ]

浮层隐藏的延迟，单位为 ms，在 alwaysShowContent 为 true 的时候无效。

boolean [ 默认值: false ]

鼠标是否可进入提示框浮层中，默认为false，如需详情内交互，如添加链接，按钮，可设置为 true。

boolean [ 默认值: false ]

是否将 tooltip 框限制在图表的区域内。

当图表外层的 dom 被设置为 'overflow: hidden'，或者移动端窄屏，导致 tooltip 超出外界被截断时，此配置比较有用。

number [ 默认值: 0.4 ]

提示框浮层的移动动画过渡时间，单位是 s，设置为 0 的时候会紧跟着鼠标移动。

string, Array, Function 提示框浮层的位置，默认不设置时位置会跟随鼠标的位置。

可选：

Array：通过数组表示提示框浮层的位置，支持数字设置绝对位置，百分比设置相对位置。示例:

 // 绝对位置，相对于容器左侧 10px, 上侧 10 px
 position: [10, 10]
 // 相对位置，放置在容器正中间 position: ['50%', '50%']

Function：

回调函数，格式如下

(point: Array, params: Object|Array.<Object>, dom: HTMLDomElement, rect: Object, size: Object) => Array

参数：

point: 鼠标位置，如 [20, 40]。
params: 同 formatter 的参数相同。
dom: tooltip 的 dom 对象。
rect: 只有鼠标在图形上时有效，是一个用x, y, width, height四个属性表达的图形包围盒。
size: 包括 dom 的尺寸和 echarts 容器的当前尺寸，例如：{contentSize: [width, height], viewSize: [width, height]}。

返回值：可以是一个表示 tooltip 位置的数组，数组值可以是绝对的像素值，也可以是相百分比。也可以是一个对象，如：{left: 10, top: 30}，或者 {right: '20%', bottom: 40}。如下示例：

 position: function (point, params, dom, rect, size) {
 // 固定在顶部
 return [point[0], '10%'];
 }

或者：

 position: function (pos, params, dom, rect, size) {
 // 鼠标在左侧时 tooltip 显示到右侧，鼠标在右侧时 tooltip 显示到左侧。
 var obj = {top: 60};
 obj[['left', 'right'][+(pos[0] < size.viewSize[0] / 2)]] = 5;
 return obj;
 }

'inside'：

鼠标所在图形的内部中心位置，只在 trigger 为'item'的时候有效。

'top'：

鼠标所在图形上侧，只在 trigger 为'item'的时候有效。

'left'：

鼠标所在图形左侧，只在 trigger 为'item'的时候有效。

'right'：

鼠标所在图形右侧，只在 trigger 为'item'的时候有效。

'bottom'：

鼠标所在图形底侧，只在 trigger 为'item'的时候有效。

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';
}

Color [ 默认值: 'rgba(50,50,50,0.7)' ]

设置提示框浮层的背景颜色。

Color [ 默认值: '#333' ]

设置提示框浮层的边框颜色。

number [ 默认值: 0 ]

设置提示框浮层的边框宽。

number [ 默认值: 5 ]

设置提示框浮层内边距，单位为 px，默认各方向内边距为 5px，接受数组分别设定上右下左边距。

使用示例：

// 设置内边距为 5
padding: 5
// 设置上下的内边距为 5，左右的内边距为 10
padding: [5, 10]
// 分别设置四个方向的内边距
padding: [
    5,  // 上
    10, // 右
    5,  // 下
    10, // 左
]

Object 设置提示框浮层的文本样式。详细的文字样式设置见：提示框组件文字的样式

string 额外附加到浮层的 css 样式。如下为浮层添加阴影的示例：

extraCssText:'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);'

提示框组件属性

提示框组件属性

tooltip.show

tooltip.trigger

tooltip.showContent

tooltip.alwaysShowContent

tooltip.triggerOn

tooltip.showDelay

tooltip.hideDelay

tooltip.enterable

tooltip.confine

tooltip.transitionDuration

tooltip.position

Function：

参数：

'inside'：

'top'：

'left'：

'right'：

'bottom'：

tooltip.formatter

1、字符串模板

示例：

2、回调函数

tooltip.backgroundColor

tooltip.borderColor

tooltip.borderWidth

tooltip.padding

tooltip.textStyle

tooltip.extraCssText

选择支付方式：