tooltip
Previous
sliderFilter
Next
Palette
Loading...
展示提示信息。
{interaction: { tooltip: true },}
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
wait | 提示信息更新的时间间隔,单位为毫秒 | number | 50 |
leading | 是否在时间间隔开始的时候更新提示信息 | boolean | true |
trailing | 是否在时间间隔结束的时候更新提示信息 | boolean | false |
shared | 相同 x 的元素是否共享 tooltip | boolean | false |
series | 是否是系列元素的 tooltip | boolean | - |
body | 是否展示 tooltip | boolean | true |
marker | 是否展示 marker | boolean | true |
groupName | 是否使用 groupName | boolean | true |
position | tooltip 位置 | TooltipPosition | - |
mount | tooltip 渲染的 dom 节点 | string | HTMLElement | 图表容器 |
bounding | tooltip 渲染的限制区域,超出会自动调整位置 | BBox | 图表区域大小 |
crosshairs | 是否展示指示线 | boolean | - |
crosshairs${StyleAttrs} | 指示线的样式 | number | string | - |
marker${StyleAttrs} | marker 的样式 | number | string | - |
render | 自定义 tooltip 渲染函数 | (event, options) => HTMLElement | string | - |
sort | item 排序器 | (d: TooltipItemValue) => any | - |
filter | item 筛选器 | (d: TooltipItemValue) => any | - |
disableNative | 是否响应原生事件(pointerover 和 pointerout) | true | boolean |
css | 设置容器的 css 样式 | - | Record<string, any> |
type TooltipPosition =| 'top'| 'bottom'| 'left'| 'right'| 'top-left'| 'top-right'| 'bottom-left'| 'bottom-right';type BBox = { x: number; y: number; width: number; height: number };
{interaction: {tooltip: {render: (event, { title, items }) => <div>Your custom render content here.</div>,},},}
let chart;const config = {onReady: (c) => chart = c}chart.on('tooltip:show', (event) => {console.log(event.data.data);});chart.on('tooltip:hide', () => {console.log('hide');});
对于 Interval、Point 等非系列 Mark,控制展示的方式如下:
// 条形图、点图等{onReady: chart => {chart.emit('tooltip:show', {data: {// 会找从原始数据里面找到匹配的数据data: { genre: 'Sports' },},})}}
对于 Line、Area 等系列 Mark,控制展示的方式如下:
{onReady: chart => {chart.emit('tooltip:show', {data: {data: { x: new Date('2010-11-16') },},})}}
隐藏的方式如下:
chart.emit('tooltip:hide');
chart.emit('tooltip:disable'); // 禁用 tooltipchart.emit('tooltip:enable'); // 启用交互