Tooltip 提示信息
Tooltip 提示信息是我们在使用 VChart 图表时,用以显示在图表不同元素上的附加信息,通过鼠标悬停操作展示出来。本教程主要讲解提示信息组件的相关概念以及组成,关于组件更加详细的配置及示例,详见配置项文档及示例页面。

Tooltip 提示信息的组成
在 VChart 图表中,Tooltip 提示信息主要 由两部分组成:
- 标题(
title):显示当前鼠标悬停的数据分类或其他相关信息。 - 内容(
content):显示当前鼠标悬停的详细数据及其属性信息。
在 VChart 上我们根据 tooltip 的显示数据提供了两种类型的 tooltip,分别为图元 tooltip('mark')和维度项 tooltip('dimension')。其中图元('mark')指的是单独某一个数据对应的图形(如下图中堆积柱图中的一个小方块)。'dimension' 指的是当前鼠标所在区域的维度值(如 x 值)对应的一组数据(如下图中堆积柱图中堆叠在一起的一组数据):

样式配置
通过 tooltip.style 属性,我们可以对 tooltip 进行样式配置。下面的代码示例展示了常见的 tooltip 面板的样式配置,如调整背景色、圆角、边框阴影等配置。
tooltip: {
style: {
panel: {
/** 背景色 */
backgroundColor: 'rgba(24,144,255, 0.1)',
/** tooltip边框 */
border: {
color: '#6690F2',
width: 2,
/** 圆角 */
radius: 4
},
/** tooltip阴影 */
shadow: {
blur: 10,
spread: 2,
color: '#6690F2'
}
}
}
}

格式化
标题格式化
有时我们需要对 Tooltip 的标题进行特定的显示格式,此时我们可以通过在对应类型的 tooltip 下的 title.value 属性进行配置,如果配置该属性为字符串,则显示为对应的常量文本。也可配置为函数回调:(datum: Datum) => string; 其中 datum 为 tooltip 当前行所默认对应的数据项。
标题格式化示例:
{
tooltip: {
// 配置 mark 图元的标题内容
mark: {
title: {
value: '标题'
}
},
// 配置 dimension 维度项的标题内容
dimension: {
title: {
value: datum => datum.value
}
},
}
}
2. 内容格式化
除了标题,我们同样也可以对 Tooltip 的内容进行格式化处理。与标题格式化类似,我们可以通过在对应类型的 tooltip 下的 content 属性进行配置,Tooltip 的每一条 content 由如下部分组成:
shape:数据项图形。key:数据项名称。value:数据项值。
当我们需要对内容进行格式化时,可以通过配置 key, value 属性进行,如果配置为字符串,则显示为对应的常量文本。也可配置为函数回调,也可配置为函数回调:(datum: Datum) => string; 其中 datum 为 tooltip 当前行所默认对应的数据项。
内容格式化示例:
{
tooltip: {
// 配置 mark 图元的内容
mark: {
content: {
key: '数值',
value: datum => datum.value
}
},
// 配置 dimension 维度项的内容
dimension: {
content: {
key: datum => datum.type,
value: datum => datum.value
}
},
}
}
自定义
当配置项无法满足 tooltip 的展示需求时,我们还提供了自定义 tooltip 的能力。可以通过配置 TooltipHandler 来覆盖默认 tooltip 展示逻辑。具体可以阅读 VChart 实例方法 setTooltipHandler 的使用。
/**
* 自定义 TooltipHandler。
* @param tooltipHandler
*/
setTooltipHandler: (tooltipHandler: ITooltipHandler) => void;