SpreadSheet

S2Event

Interaction

参数	说明	类型	版本
themeName	主题名	ThemeName
theme	主题配置	S2Theme
store	存储的一些信息	Store
dataCfg	数据配置	S2DataConfig
options	表格配置	S2Options
dataSet	表格数据集（字段，数据，排序）	BaseDataSet
facet	当前可视渲染区域	BaseFacet
tooltip	提示信息	BaseTooltip
container	g-canvas 实例	Canvas
interaction	交互	Interaction
hdAdapter	高清适配器	HdAdapter
destroyed	表格是否已销毁	`boolean`
on	事件订阅	(event: S2Event, listener: () => void) => void
emit	事件发布	(event: S2Event, ...args: any[]) => void
getDataSet	获取数据集	(options: S2Options) => BaseDataSet
isPivotMode	是否是透视表	`() => boolean`
isCustomRowFields	是否是自定义行头维值	`() => boolean`
isCustomColumnFields	是否是自定义列头维值	`() => boolean`
isCustomHeaderFields	是否是自定义表头维值	`() => boolean`
isHierarchyTreeType	是否是树状结构	`() => boolean`
isFrozenRowHeader	是否是冻结行头状态	`() => boolean`
isTableMode	是否是明细表	`() => boolean`
isValueInCols	是否是数值置于行头	`() => boolean`
clearDrillDownData	清除下钻数据	(rowNodeId?: `string`) => `Promise<void>`
showTooltip	显示 tooltip （别名 `tooltip.show`	(showOptions: TooltipShowOptions) => void
showTooltipWithInfo	显示 tooltip, 并且展示一些默认信息	(event: FederatedPointerEvent \| MouseEvent, data: TooltipData[], options?: TooltipOptions) => void
hideTooltip	隐藏 tooltip （别名：`tooltip.hide`	`() => void`
destroyTooltip	销毁 tooltip （别名 `tooltip.destroy`	`() => void`
registerIcons	注册自定义 svg 图标（根据 `options.customSVGIcons`	`() => void`
setDataCfg	更新表格数据	`<T extends boolean = false>(dataCfg: T extends true ?` `S2DataConfig` `: Partial<S2DataConfig>, reset?: T) => void`	`reset` 参数需在 `@antv/s2^1.34.0`版本使用
setOptions	更新表格配置	(options: S2Options, reset?: boolean) => void	`reset` 参数需在 `@antv/s2^1.34.0`版本使用
resetDataCfg	重置表格数据	() => void
resetOptions	重置表格配置	() => void
render	重新渲染表格，如果 `reloadData` = true, 则会重新计算数据，`rebuildDataSet` = true, 重新构建数据集，`rebuildHiddenColumnsDetail` = true 重新构建隐藏列信息	`(reloadData?: boolean \| { reloadData?: boolean, rebuildDataSet?: boolean; rebuildHiddenColumnsDetail?: boolean }) => Promise<void>`
destroy	销毁表格	`() => void`
setThemeCfg	更新主题配置（含主题 schema, 色板，主题名）	(themeCfg: ThemeCfg) => void
setTheme	更新主题（只包含主题 scheme)	(theme: S2Theme) => void
getTheme	获取主题（只包含主题 scheme)	( ) => S2Theme
getThemeName	获取主题名	() => ThemeName
updatePagination	更新分页	(pagination: Pagination) => void
changeSheetSize	修改表格画布大小，不用重新加载数据	`(width?: number, height?: number) => void`
getLayoutWidthType	获取单元格宽度布局类型（LayoutWidthType: `adaptive（自适应）` \| `colAdaptive（列自适应）` \| `compact（紧凑）`）	() => `LayoutWidthType`
getCell	根据 event.target 获取当前单元格	(target: EventTarget) => S2CellType
getCellType	根据 event.target 获取当前单元格类型	(target: EventTarget) => CellType
getTotalsConfig	获取总计小计配置	(dimension: string) => Total
getCanvasElement	获取表格对应的 `<canvas/>` HTML 元素	() => HTMLCanvasElement
getCanvas	获取 G Canvas 实例	() => Canvas
getCanvasConfig	获取 G Canvas 配置	() => Partial<CanvasConfig>
updateSortMethodMap	更新存储在 store 中的节点排序方式 map, replace 为是否覆盖上一次的值	(nodeId: string, sortMethod: string, replace?: boolean) => void
getMenuDefaultSelectedKeys	获取 tooltip 中选中的菜单项 key 值	`(nodeId: string) => string[]`
measureText	获取文本在画布中的测量信息	(text: `string`, font: TextTheme) => TextMetrics \| `null`
measureTextWidth	获取文本在画布中的测量宽度	(text: `string`, font: TextTheme) => `number` \| `null`
measureTextHeight	获取文本在画布中的测量高度	(text:`string`, font: TextTheme) => `number` \| `null`
groupSortByMethod	组内排序（透视表有效）	(sortMethod: `'asc' \| 'desc'`, meta: Node) => `Promise<void> \| void`
getSeriesNumberText	获取序号文本（根据 `s2Options.series.text` 配置，默认 "序号")	() => string

参数

说明

类型

版本

themeName

主题名

ThemeName

theme

主题配置

S2Theme

store

存储的一些信息

Store

dataCfg

数据配置

S2DataConfig

options

表格配置

S2Options

dataSet

表格数据集（字段，数据，排序）

BaseDataSet

facet

当前可视渲染区域

BaseFacet

tooltip

提示信息

BaseTooltip

container

g-canvas 实例

Canvas

interaction

交互

Interaction

hdAdapter

高清适配器

HdAdapter

destroyed

表格是否已销毁

boolean

事件订阅

(event: S2Event, listener: () => void) => void

emit

事件发布

(event: S2Event, ...args: any[]) => void

getDataSet

获取数据集

(options: S2Options) => BaseDataSet

isPivotMode

是否是透视表

() => boolean

isCustomRowFields

是否是自定义行头维值

() => boolean

isCustomColumnFields

是否是自定义列头维值

() => boolean

isCustomHeaderFields

是否是自定义表头维值

() => boolean

isHierarchyTreeType

是否是树状结构

() => boolean

isFrozenRowHeader

是否是冻结行头状态

() => boolean

isTableMode

是否是明细表

() => boolean

isValueInCols

是否是数值置于行头

() => boolean

clearDrillDownData

清除下钻数据

(rowNodeId?: string) => Promise<void>

showTooltip

显示 tooltip （别名 tooltip.show

(showOptions: TooltipShowOptions) => void

showTooltipWithInfo

显示 tooltip, 并且展示一些默认信息

(event: FederatedPointerEvent | MouseEvent, data: TooltipData[], options?: TooltipOptions) => void

hideTooltip

隐藏 tooltip （别名：tooltip.hide

() => void

destroyTooltip

销毁 tooltip （别名 tooltip.destroy

() => void

registerIcons

注册自定义 svg 图标（根据 options.customSVGIcons

() => void

setDataCfg

更新表格数据

<T extends boolean = false>(dataCfg: T extends true ? S2DataConfig : Partial<S2DataConfig>, reset?: T) => void

reset 参数需在 @antv/s2^1.34.0版本使用

setOptions

更新表格配置

(options: S2Options, reset?: boolean) => void

reset 参数需在 @antv/s2^1.34.0版本使用

resetDataCfg

重置表格数据

() => void

resetOptions

重置表格配置

() => void

render

重新渲染表格，如果 reloadData = true, 则会重新计算数据，rebuildDataSet = true, 重新构建数据集，rebuildHiddenColumnsDetail = true 重新构建隐藏列信息

(reloadData?: boolean | { reloadData?: boolean, rebuildDataSet?: boolean; rebuildHiddenColumnsDetail?: boolean }) => Promise<void>

destroy

销毁表格

() => void

setThemeCfg

更新主题配置（含主题 schema, 色板，主题名）

(themeCfg: ThemeCfg) => void

setTheme

更新主题（只包含主题 scheme)

(theme: S2Theme) => void

getTheme

获取主题（只包含主题 scheme)

( ) => S2Theme

getThemeName

获取主题名

() => ThemeName

updatePagination

更新分页

(pagination: Pagination) => void

changeSheetSize

修改表格画布大小，不用重新加载数据

(width?: number, height?: number) => void

getLayoutWidthType

获取单元格宽度布局类型（LayoutWidthType: adaptive（自适应） | colAdaptive（列自适应） | compact（紧凑））

() => LayoutWidthType

getCell

根据 event.target 获取当前单元格

(target: EventTarget) => S2CellType

getCellType

根据 event.target 获取当前单元格类型

(target: EventTarget) => CellType

getTotalsConfig

获取总计小计配置

(dimension: string) => Total

getCanvasElement

获取表格对应的 <canvas/> HTML 元素

() => HTMLCanvasElement

getCanvas

获取 G Canvas 实例

() => Canvas

getCanvasConfig

获取 G Canvas 配置

() => Partial<CanvasConfig>

updateSortMethodMap

更新存储在 store 中的节点排序方式 map, replace 为是否覆盖上一次的值

(nodeId: string, sortMethod: string, replace?: boolean) => void

getMenuDefaultSelectedKeys

获取 tooltip 中选中的菜单项 key 值

(nodeId: string) => string[]

measureText

获取文本在画布中的测量信息

(text: string, font: TextTheme) => TextMetrics | null

measureTextWidth

获取文本在画布中的测量宽度

(text: string, font: TextTheme) => number | null

measureTextHeight

获取文本在画布中的测量高度

(text:string, font: TextTheme) => number | null

groupSortByMethod

组内排序（透视表有效）

(sortMethod: 'asc' | 'desc', meta: Node) => Promise<void> | void

getSeriesNumberText

获取序号文本（根据 s2Options.series.text 配置，默认 "序号")

() => string

interface ScrollOffsetConfig {

rowHeaderOffsetX?: {

value: number | undefined;

animate?: boolean;

};

offsetX?: {

value: number | undefined;

animate?: boolean;

};

offsetY?: {

value: number | undefined;

animate?: boolean;

};

}

export enum CellType {

DATA_CELL = 'dataCell', // 数值单元格

ROW_CELL = 'rowCell', // 行头单元格

COL_CELL = 'colCell', // 列头单元格

CORNER_CELL = 'cornerCell', // 角头单元格

MERGED_CELL = 'mergedCell', // 合并后的单元格

}

参数	说明	类型	版本
themeName	主题名	ThemeName
theme	主题配置	S2Theme
store	存储的一些信息	Store
dataCfg	数据配置	S2DataConfig
options	表格配置	S2Options
dataSet	表格数据集（字段，数据，排序）	BaseDataSet
facet	当前可视渲染区域	BaseFacet
tooltip	提示信息	BaseTooltip
container	g-canvas 实例	Canvas
interaction	交互	Interaction
hdAdapter	高清适配器	HdAdapter
destroyed	表格是否已销毁	`boolean`
on	事件订阅	(event: S2Event, listener: () => void) => void
emit	事件发布	(event: S2Event, ...args: any[]) => void
getDataSet	获取数据集	(options: S2Options) => BaseDataSet
isPivotMode	是否是透视表	`() => boolean`
isCustomRowFields	是否是自定义行头维值	`() => boolean`
isCustomColumnFields	是否是自定义列头维值	`() => boolean`
isCustomHeaderFields	是否是自定义表头维值	`() => boolean`
isHierarchyTreeType	是否是树状结构	`() => boolean`
isFrozenRowHeader	是否是冻结行头状态	`() => boolean`
isTableMode	是否是明细表	`() => boolean`
isValueInCols	是否是数值置于行头	`() => boolean`
clearDrillDownData	清除下钻数据	(rowNodeId?: `string`) => `Promise<void>`
showTooltip	显示 tooltip （别名 `tooltip.show`	(showOptions: TooltipShowOptions) => void
showTooltipWithInfo	显示 tooltip, 并且展示一些默认信息	(event: FederatedPointerEvent \| MouseEvent, data: TooltipData[], options?: TooltipOptions) => void
hideTooltip	隐藏 tooltip （别名：`tooltip.hide`	`() => void`
destroyTooltip	销毁 tooltip （别名 `tooltip.destroy`	`() => void`
registerIcons	注册自定义 svg 图标（根据 `options.customSVGIcons`	`() => void`
setDataCfg	更新表格数据	`<T extends boolean = false>(dataCfg: T extends true ?` `S2DataConfig` `: Partial<S2DataConfig>, reset?: T) => void`	`reset` 参数需在 `@antv/s2^1.34.0`版本使用
setOptions	更新表格配置	(options: S2Options, reset?: boolean) => void	`reset` 参数需在 `@antv/s2^1.34.0`版本使用
resetDataCfg	重置表格数据	() => void
resetOptions	重置表格配置	() => void
render	重新渲染表格，如果 `reloadData` = true, 则会重新计算数据，`rebuildDataSet` = true, 重新构建数据集，`rebuildHiddenColumnsDetail` = true 重新构建隐藏列信息	`(reloadData?: boolean \| { reloadData?: boolean, rebuildDataSet?: boolean; rebuildHiddenColumnsDetail?: boolean }) => Promise<void>`
destroy	销毁表格	`() => void`
setThemeCfg	更新主题配置（含主题 schema, 色板，主题名）	(themeCfg: ThemeCfg) => void
setTheme	更新主题（只包含主题 scheme)	(theme: S2Theme) => void
getTheme	获取主题（只包含主题 scheme)	( ) => S2Theme
getThemeName	获取主题名	() => ThemeName
updatePagination	更新分页	(pagination: Pagination) => void
changeSheetSize	修改表格画布大小，不用重新加载数据	`(width?: number, height?: number) => void`
getLayoutWidthType	获取单元格宽度布局类型（LayoutWidthType: `adaptive（自适应）` \| `colAdaptive（列自适应）` \| `compact（紧凑）`）	() => `LayoutWidthType`
getCell	根据 event.target 获取当前单元格	(target: EventTarget) => S2CellType
getCellType	根据 event.target 获取当前单元格类型	(target: EventTarget) => CellType
getTotalsConfig	获取总计小计配置	(dimension: string) => Total
getCanvasElement	获取表格对应的 `<canvas/>` HTML 元素	() => HTMLCanvasElement
getCanvas	获取 G Canvas 实例	() => Canvas
getCanvasConfig	获取 G Canvas 配置	() => Partial<CanvasConfig>
updateSortMethodMap	更新存储在 store 中的节点排序方式 map, replace 为是否覆盖上一次的值	(nodeId: string, sortMethod: string, replace?: boolean) => void
getMenuDefaultSelectedKeys	获取 tooltip 中选中的菜单项 key 值	`(nodeId: string) => string[]`
measureText	获取文本在画布中的测量信息	(text: `string`, font: TextTheme) => TextMetrics \| `null`
measureTextWidth	获取文本在画布中的测量宽度	(text: `string`, font: TextTheme) => `number` \| `null`
measureTextHeight	获取文本在画布中的测量高度	(text:`string`, font: TextTheme) => `number` \| `null`
groupSortByMethod	组内排序（透视表有效）	(sortMethod: `'asc' \| 'desc'`, meta: Node) => `Promise<void> \| void`
getSeriesNumberText	获取序号文本（根据 `s2Options.series.text` 配置，默认 "序号")	() => string

参数

说明

类型

版本

themeName

主题名

ThemeName

theme

主题配置

S2Theme

store

存储的一些信息

Store

dataCfg

数据配置

S2DataConfig

options

表格配置

S2Options

dataSet

表格数据集（字段，数据，排序）

BaseDataSet

facet

当前可视渲染区域

BaseFacet

tooltip

提示信息

BaseTooltip

container

g-canvas 实例

Canvas

interaction

交互

Interaction

hdAdapter

高清适配器

HdAdapter

destroyed

表格是否已销毁

boolean

事件订阅

(event: S2Event, listener: () => void) => void

emit

事件发布

(event: S2Event, ...args: any[]) => void

getDataSet

获取数据集

(options: S2Options) => BaseDataSet

isPivotMode

是否是透视表

() => boolean

isCustomRowFields

是否是自定义行头维值

() => boolean

isCustomColumnFields

是否是自定义列头维值

() => boolean

isCustomHeaderFields

是否是自定义表头维值

() => boolean

isHierarchyTreeType

是否是树状结构

() => boolean

isFrozenRowHeader

是否是冻结行头状态

() => boolean

isTableMode

是否是明细表

() => boolean

isValueInCols

是否是数值置于行头

() => boolean

clearDrillDownData

清除下钻数据

(rowNodeId?: string) => Promise<void>

showTooltip

显示 tooltip （别名 tooltip.show

(showOptions: TooltipShowOptions) => void

showTooltipWithInfo

显示 tooltip, 并且展示一些默认信息

(event: FederatedPointerEvent | MouseEvent, data: TooltipData[], options?: TooltipOptions) => void

hideTooltip

隐藏 tooltip （别名：tooltip.hide

() => void

destroyTooltip

销毁 tooltip （别名 tooltip.destroy

() => void

registerIcons

注册自定义 svg 图标（根据 options.customSVGIcons

() => void

setDataCfg

更新表格数据

<T extends boolean = false>(dataCfg: T extends true ? S2DataConfig : Partial<S2DataConfig>, reset?: T) => void

reset 参数需在 @antv/s2^1.34.0版本使用

setOptions

更新表格配置

(options: S2Options, reset?: boolean) => void

reset 参数需在 @antv/s2^1.34.0版本使用

resetDataCfg

重置表格数据

() => void

resetOptions

重置表格配置

() => void

render

重新渲染表格，如果 reloadData = true, 则会重新计算数据，rebuildDataSet = true, 重新构建数据集，rebuildHiddenColumnsDetail = true 重新构建隐藏列信息

(reloadData?: boolean | { reloadData?: boolean, rebuildDataSet?: boolean; rebuildHiddenColumnsDetail?: boolean }) => Promise<void>

destroy

销毁表格

() => void

setThemeCfg

更新主题配置（含主题 schema, 色板，主题名）

(themeCfg: ThemeCfg) => void

setTheme

更新主题（只包含主题 scheme)

(theme: S2Theme) => void

getTheme

获取主题（只包含主题 scheme)

( ) => S2Theme

getThemeName

获取主题名

() => ThemeName

updatePagination

更新分页

(pagination: Pagination) => void

changeSheetSize

修改表格画布大小，不用重新加载数据

(width?: number, height?: number) => void

getLayoutWidthType

获取单元格宽度布局类型（LayoutWidthType: adaptive（自适应） | colAdaptive（列自适应） | compact（紧凑））

() => LayoutWidthType

getCell

根据 event.target 获取当前单元格

(target: EventTarget) => S2CellType

getCellType

根据 event.target 获取当前单元格类型

(target: EventTarget) => CellType

getTotalsConfig

获取总计小计配置

(dimension: string) => Total

getCanvasElement

获取表格对应的 <canvas/> HTML 元素

() => HTMLCanvasElement

getCanvas

获取 G Canvas 实例

() => Canvas

getCanvasConfig

获取 G Canvas 配置

() => Partial<CanvasConfig>

updateSortMethodMap

更新存储在 store 中的节点排序方式 map, replace 为是否覆盖上一次的值

(nodeId: string, sortMethod: string, replace?: boolean) => void

getMenuDefaultSelectedKeys

获取 tooltip 中选中的菜单项 key 值

(nodeId: string) => string[]

measureText

获取文本在画布中的测量信息

(text: string, font: TextTheme) => TextMetrics | null

measureTextWidth

获取文本在画布中的测量宽度

(text: string, font: TextTheme) => number | null

measureTextHeight

获取文本在画布中的测量高度

(text:string, font: TextTheme) => number | null

groupSortByMethod

组内排序（透视表有效）

(sortMethod: 'asc' | 'desc', meta: Node) => Promise<void> | void

getSeriesNumberText

获取序号文本（根据 s2Options.series.text 配置，默认 "序号")

() => string

interface ScrollOffsetConfig {

rowHeaderOffsetX?: {

value: number | undefined;

animate?: boolean;

};

offsetX?: {

value: number | undefined;

animate?: boolean;

};

offsetY?: {

value: number | undefined;

animate?: boolean;

};

}

export enum CellType {

DATA_CELL = 'dataCell', // 数值单元格

ROW_CELL = 'rowCell', // 行头单元格

COL_CELL = 'colCell', // 列头单元格

CORNER_CELL = 'cornerCell', // 角头单元格

MERGED_CELL = 'mergedCell', // 合并后的单元格

}

S2

SpreadSheet

S2

SpreadSheet

S2MountContainer

ScrollOffsetConfig

CellType

BBox

S2MountContainer

ScrollOffsetConfig

CellType

BBox