logo

S2

  • 使用文档
  • API 文档
  • 图表示例
  • 在线体验
  • 更新日志
  • 所有产品antv logo arrow
  • 2.x
  • 基础配置项
    • S2DataConfig
    • S2Options
      Updated
    • S2Theme
      Updated
    • S2Event
      Updated
  • 基础类
    • SpreadSheet
      Updated
    • Interaction
      Updated
    • Store
    • BaseCell
      Updated
    • BaseDataSet
      Updated
    • Node
    • BaseTooltip
    • BaseFacet
      Updated
    • Hierarchy
      New
    • BaseBBox
      New
    • CellData
      New
  • 分析组件
    • 表组件
      Updated
    • 维度下钻
      Updated
    • 维度切换组件
      Updated
    • 高级排序
      Updated
    • 导出
      Updated
  • 绘图属性
  • 透视组合图拓展 S2Options

BaseTooltip

上一篇
Node
下一篇
BaseFacet

Resources

Ant Design
Galacea Effects
Umi-React 应用开发框架
Dumi-组件/文档研发工具
ahooks-React Hooks 库

社区

体验科技专栏
seeconfSEE Conf-蚂蚁体验科技大会

帮助

GitHub
StackOverflow

more products更多产品

Ant DesignAnt Design-企业级 UI 设计语言
yuque语雀-知识创作与分享工具
EggEgg-企业级 Node 开发框架
kitchenKitchen-Sketch 工具集
GalaceanGalacean-互动图形解决方案
xtech蚂蚁体验科技
© Copyright 2025 Ant Group Co., Ltd..备案号:京ICP备15032932号-38

Loading...

功能描述:Tooltip 类。详情

s2.tooltip.show({
position: {
x: 0,
y: 0,
},
content: 'xxx'
})
参数说明类型
spreadsheet表格实例() => SpreadSheet
containertooltip 挂载容器HTMLElement
optionstooltip 配置TooltipShowOptions
position坐标{ x: number, y: number }
visible显示状态boolean
show显示 tooltip(showOptions: TooltipShowOptions) => void
hide隐藏 tooltip() => void
destroy销毁 tooltip, 并移除挂载容器() => void
clearContent清空 tooltip 内容() => void
disablePointerEvent禁用 tooltip 鼠标响应() => void

TooltipShowOptions

功能描述:tooltip 显示配置。

参数类型必选默认值功能描述
positionTooltipPosition✓tooltip 显示位置
dataTooltipDatatooltip 数据
cellInfosRecord<string, any>单元格信息
optionsTooltipOptionstooltip 部分配置
contentReactNode | string | 或者 (cell, defaultTooltipShowOptions: TooltipShowOptions) => ReactNode | string自定义 tooltip 内容
eventEvent当前事件 Event

TooltipPosition

功能描述:tooltip 坐标

参数类型必选默认值功能描述
xnumber✓横坐标
ynumber✓纵坐标

TooltipData

功能描述:tooltip 数据

参数类型必选默认值功能描述
summariesTooltipSummaryOptions所选项统计(按度量值区分)列表
detailsListItem数据点明细信息
headInfoTooltipHeadInfo轴(行/列头)列表
namestring当前单元格名称
tipsstring提示/说明信息
infosstring底部提示信息(可用于快捷键操作提示)

TooltipSummaryOptions

功能描述:tooltip 所选项统计(按度量值区分)列表

参数类型必选默认值功能描述
namestring✓名称
valuenumber | string✓值
selectedDataRecord<string, any>✓当前选择的数据列表

TooltipHeadInfo

功能描述: tooltip 轴(行/列头)列表

参数类型必选默认值功能描述
rowsListItem✓行头列表
colsListItem✓列头列表

ListItem

功能描述:tooltip 数据点明细数据

参数类型必选默认值功能描述
namestring✓名称
valuestring | number✓值
iconReactNode自定义图标组件

TooltipOptions

功能描述:tooltip 配置

参数类型必选默认值功能描述
hideSummarybooleanfalse是否隐藏所选项统计信息
operatorTooltipOperatorOptions操作栏配置
onlyShowOperatorbooleanfalse是否只展示操作菜单项
isTotalsbooleanfalse是否是 总计/小计 单元格
onlyShowCellTextbooleanfalse是否只显示当前单元格文本
enableFormatbooleanfalse是否开启格式化
forceRenderbooleanfalse是否强制清空 dom
dataTooltipData-自定义 tooltip 数据

TooltipOperatorOptions

功能描述:tooltip 操作栏配置

参数类型必选默认值功能描述
menuTooltipOperatorMenuOptions操作项菜单配置

TooltipOperatorMenuOptions

功能描述: tooltip 操作栏菜单配置

参数类型必选默认值功能描述
itemsTooltipOperatorMenuItem[]操作项列表
onClick(info: TooltipOperatorMenuInfo, cell: S2CellType) => void点击事件
selectedKeysstring[]初始选中的菜单项 key 数组
TooltipOperatorMenuItem

功能描述: tooltip 操作项列表

参数类型必选默认值功能描述
keystring✓唯一标识
labelReactNode | string名称
iconReactNode | Element | string自定义图标
visibleboolean | (cell: S2CellType) => booleantrue操作项是否显示,可传入一个函数根据当前单元格信息动态显示
onClick(info: { key: string, [key: string]: unknown; } , cell: S2CellType) => void点击事件回调 (info 为当前点击的菜单项,cell 为当前 tooltip 对应的单元格)
childrenTooltipOperatorMenuItem[]子菜单列表