--- title: Interaction order: 2 --- 功能描述:交互类相关属性和方法。[详情](https://github.com/antvis/S2/blob/next/packages/s2-core/src/interaction/root.ts) ```ts s2.interaction.reset() ``` | 参数 | 说明 | 类型 | | --- |--------------------------------------------------| --- | | spreadsheet | 表格实例 | [SpreadSheet](/api/basic-class/spreadsheet) | | interactions | 当前已注册的交互 | `Map` | | intercepts | 当前拦截的交互,防止不同交互之间冲突 ([查看示例](/examples/interaction/advanced/#intercepts)) | `Set` | | eventController | 事件控制器 | [EventController](#eventcontroller) | | destroy | 卸载所有交互实例,并重置为初始状态 | `() => void` | | reset | 重置所有交互 | `() => void` | | setState | 设置状态 | (data: [InteractionStateInfo](#interactionstateinfo)) => void | | getState | 获取当前状态 | `() => void` | | resetState | 重置为初始状态 | `() => void` | | clearState | 清空状态,并重绘 | `() => void` | | changeState | 更新状态 | (data: [InteractionStateInfo](#interactionstateinfo)) => void | | setInteractedCells | 设置当前发生改变的单元格 | (cell: [S2CellType](#s2celltype)) => void | | getInteractedCells | 获取当前发生改变的单元格 | () => [S2CellType](#s2celltype)[] | | getCurrentStateName | 获取当前状态名 | `() => void` | | isEqualStateName | 是否是相同的状态名 | (name: [InteractionStateName](#interactionstatename)) => boolean | | isSelectedState | 是否是选中状态 | `() => boolean` | | isBrushSelectedState | 是否是刷选状态 | `() => boolean` | | isHoverState | 是否是悬停状态 | `() => boolean` | | isHoverFocusState | 是否是悬停聚焦状态 (悬停在单元格 `focusTime`: 默认 800ms 后) | `() => boolean` | | isSelectedCell | 是否是选中的单元格 | (cell: [S2CellType](#s2celltype)) => boolean | | isActiveCell | 是否是激活的单元格 | (cell: [S2CellType](#s2celltype)) => boolean | | getCells | 获取当前 interaction 记录的 Cells 元信息列表,包括不在可视范围内的单元格 | () => Partial<[ViewMeta](#viewmeta)>[] | | getActiveCells | 获取当前在可视区域的单元格实例 | `() => S2CellType[]` | | clearStyleIndependent | 清除单元格交互样式 | `() => void` | | getActiveDataCells | 获取当前在可视区域的数值单元格实例 | `() => S2CellType[]` | | getActiveRowCells | 获取当前在可视区域的行头单元格实例 | `() => S2CellType[]` | | getActiveColCells | 获取当前在可视区域的列头单元格实例 | `() => S2CellType[]` | | clearStyleIndependent | 清除单元格样式 | `() => void` | | getUnSelectedDataCells | 获取可视区域内选中的数值单元格 | `() => DataCell[]` | | getAllCells | 获取所有可视区域内的单元格 | () => [S2CellType](#s2celltype)[] | | selectAll | 选中所有单元格 | `() => void` | | hideColumns | 隐藏列 (forceRender 为 `false` 时,隐藏列为空的情况下,不再触发表格更新) | `(hiddenColumnFields: string[], forceRender?: boolean = true) => void` | | mergeCells | 合并单元格 | (cellsInfo?: [MergedCellInfo](#mergedcellinfo)[], hideData?: boolean) => void | | unmergeCell | 取消合并单元格 | `(removedCell: MergedCell) => void` | | updateAllDataCells | 更新所有数值单元格 | `() => void` | | updateCells | 更新指定单元格 | (cells: [S2CellType](#s2celltype)[]) => void | | addIntercepts | 新增交互拦截 | (interceptTypes: [InterceptType](#intercepttype)[]) => void | | hasIntercepts | 是否有指定拦截的交互 | (interceptTypes: [InterceptType](#intercepttype)[]) => boolean | | removeIntercepts | 移除指定交互拦截 | (interceptTypes: [InterceptType](#intercepttype)[]) => void | | highlightNodes | 高亮节点对应的单元格 | (nodes: [Node](/api/basic-class/node)[], stateName: [InteractionStateName](#interactionstatename)) => void | | scrollTo | 滚动至指定位置 | (offsetConfig: [ScrollOffsetConfig](#offsetconfig)) => void | | | scrollToNode | 滚动至指定单元格节点 | (node: [Node](/api/basic-class/node), options?: [CellScrollToOptions](#cellscrolltooptions)) => void | | | scrollToCell | 滚动至指定单元格 | (cell: [S2CellType](#s2celltype), options?: [CellScrollToOptions](#cellscrolltooptions)) => void | | | scrollToCellById | 滚动至指定单元格 id 对应的位置,确保目标单元格进入可视区域 | (id: string, options?: [CellScrollToOptions](#cellscrolltooptions)) => void | | | scrollToTop | 滚动至顶部 | (options?: [CellScrollToOptions](#cellscrolltooptions)) => void | | | scrollToRight | 滚动至右边 | (options?: [CellScrollToOptions](#cellscrolltooptions)) => void | | | scrollToBottom | 滚动至底部 | (options?: [CellScrollToOptions](#cellscrolltooptions)) => void | | | scrollToLeft | 滚动至左边 | (options?: [CellScrollToOptions](#cellscrolltooptions)) => void | | | highlightCell | 高亮指定单元格(可视范围内)| (cell: [S2CellType](#s2celltype)) => void | | | selectCell | 选中指定单元格(可视范围内)| (cell: [S2CellType](#s2celltype), options: [ChangeCellOptions](#changecelloptions)) => void | | | changeCell | 改变指定单元格状态(可视范围内)(如:选中/高亮/多选等) | (cell: [S2CellType](#s2celltype), options: [ChangeCellOptions](#changecelloptions)) => void | | | updateDataCellRelevantHeaderCells | 高亮数值单元格和所对应行列单元格 | (stateName: [InteractionStateName](#interactionstatename), meta: [ViewMeta](#viewmeta)) => void | | updateDataCellRelevantRowCells | 高亮数值单元格和所对应行头单元格 | (stateName: [InteractionStateName](#interactionstatename), meta: [ViewMeta](#viewmeta)) => void | | updateDataCellRelevantColCells | 高亮数值单元格和所对应列头单元格 | (stateName: [InteractionStateName](#interactionstatename), meta: [ViewMeta](#viewmeta)) => void | ### CellScrollToOptions ```ts export interface CellScrollToOptions { /** * 是否展示滚动动画 */ animate?: boolean; /** * 是否触发滚动事件 */ skipScrollEvent?: boolean; } ``` ### StickyHeaderOptions ```ts export interface StickyHeaderOptions { /** * 吸顶时的 top 偏移量 (应对外部业务带有固定 Header 的情况, 如导航栏) * @default 0 */ offsetTop?: number | (() => number); /** * 绑定的外部滚动容器 (默认 window) */ scrollContainer?: HTMLElement | Window; /** * 是否启用吸顶表头的交互能力 (排序/resize/展开折叠等) * @default false */ enableInteraction?: boolean; } ``` ### ChangeCellOptions ```ts export interface ChangeCellOptions extends CellScrollToOptions { /** * 目标单元格 */ cell: S2CellType; /** * 是否是多选 */ isMultiSelection?: boolean; /** * 状态名 (默认 `selected`) */ stateName?: `${InteractionStateName}`; /** * 如果单元格不在可视范围,是否自动滚动 */ scrollIntoView?: boolean; } ``` ### ScrollOffsetConfig ```ts export interface ScrollOffsetConfig { skipScrollEvent?: boolean; rowHeaderOffsetX?: { value: number | undefined; animate?: boolean; }; offsetX?: { value: number | undefined; animate?: boolean; }; offsetY?: { value: number | undefined; animate?: boolean; }; } ``` ### ScrollOffset ```ts export interface ScrollOffset { scrollX?: number; scrollY?: number; rowHeaderScrollX?: number; } ``` ### InteractionConstructor ```ts export type InteractionConstructor = new ( spreadsheet: SpreadSheet, ) => BaseEvent; ``` ### BaseEvent ```ts export abstract class BaseEvent { public spreadsheet: SpreadSheet; constructor(spreadsheet: SpreadSheet) { this.spreadsheet = spreadsheet; this.bindEvents(); } public abstract bindEvents(): void; } ``` ### S2CellType ```ts type S2CellType = | DataCell | HeaderCell | ColCell | CornerCell | RowCell | SeriesNumberCell | MergedCell | TableDataCell | TableCornerCell | TableSeriesNumberCell | BaseCell; ``` ### MergedCellInfo ```ts interface MergedCellInfo { colIndex?: number; rowIndex?: number; showText?: boolean; } ``` ### CellMeta ```ts interface CellMeta { id: string; colIndex: number; rowIndex: number; type: CellType; rowQuery?: Record; [key: string]: unknown; } ``` ### InteractionStateInfo ```ts interface InteractionStateInfo { stateName?: InteractionStateName; cells?: CellMeta[]; interactedCells?: S2CellType[]; nodes?: Node[]; force?: boolean; } ``` ### EventController | 参数 | 说明 | 类型 | | --- |--------| --- | | spreadsheet | 表格实例 | [SpreadSheet](/api/basic-class/spreadsheet) | | canvasEventHandlers | 当前已注册的交互 | [EventHandler](#eventhandler)[] | | s2EventHandlers | 当前已注册的交互 | [S2EventHandler](#s2eventhandler)[] | | domEventListeners | 当前已注册的交互 | [EventHandler](#eventhandler)[] | | isCanvasEffect | 是否是图表内部引起的事件 | boolean | | canvasMousemoveEvent | 表格鼠标移动事件 | [FederatedPointerEvent](https://g.antv.antgroup.com/api/event/event-object) | | isMatchElement | 是否是表格内部的元素 | (event: MouseEvent) => boolean | | isMatchPoint | 是否是表格内部的坐标 | (event: MouseEvent) => boolean | | bindEvents | 绑定交互事件 | `() => void` | | clear | 清空交互事件 | `() => void` | | getViewportPoint | 获取表格内的鼠标坐标 | `(event: MouseEvent \| PointerEvent \| WheelEvent) => PointLike` | ### EventListener ```ts interface EventListener { target: EventTarget; type: string; handler: EventListenerOrEventListenerObject; options?: AddEventListenerOptions | boolean; } ``` ### S2EventHandler ```ts interface S2EventHandler { type: keyof EmitterType; handler: EmitterType[keyof EmitterType]; } ``` ### EventHandler ```ts interface EventHandler { type: string; handler: (event: FederatedPointerEvent) => void; } ```