API

功能描述:交互类相关属性和方法。详情

s2.interaction.reset() 
参数说明类型
spreadsheet表格实例SpreadSheet
interactions当前已注册的交互Map<string, BaseEvent>
intercepts当前拦截的交互,防止不同交互之间冲突 (查看示例)Set<Intercept>
eventController事件控制器EventController
destroy卸载所有交互实例,并重置为初始状态() => void
reset重置所有交互() => void
setState设置状态(data: InteractionStateInfo) => void
getState获取当前状态() => void
resetState重置为初始状态() => void
clearState清空状态,并重绘() => void
changeState更新状态(data: InteractionStateInfo) => void
setInteractedCells设置当前发生改变的单元格(cell: S2CellType) => void
getInteractedCells获取当前发生改变的单元格() => S2CellType[]
getCurrentStateName获取当前状态名() => void
isEqualStateName是否是相同的状态名(name: InteractionStateName) => boolean
isSelectedState是否是选中状态() => boolean
isBrushSelectedState是否是刷选状态() => boolean
isHoverState是否是悬停状态() => boolean
isHoverFocusState是否是悬停聚焦状态 (悬停在单元格 focusTime: 默认 800ms 后)() => boolean
isSelectedCell是否是选中的单元格(cell: S2CellType) => boolean
isActiveCell是否是激活的单元格(cell: S2CellType) => boolean
getCells获取当前 interaction 记录的 Cells 元信息列表,包括不在可视范围内的单元格() => Partial<ViewMeta>[]
getActiveCells获取当前在可视区域的单元格实例() => S2CellType[]
clearStyleIndependent清除单元格交互样式() => void
getActiveDataCells获取当前在可视区域的数值单元格实例() => S2CellType[]
getActiveRowCells获取当前在可视区域的行头单元格实例() => S2CellType[]
getActiveColCells获取当前在可视区域的列头单元格实例() => S2CellType[]
clearStyleIndependent清除单元格样式() => void
getUnSelectedDataCells获取可视区域内选中的数值单元格() => DataCell[]
getAllCells获取所有可视区域内的单元格() => S2CellType[]
selectAll选中所有单元格() => void
hideColumns隐藏列 (forceRender 为 false 时,隐藏列为空的情况下,不再触发表格更新)(hiddenColumnFields: string[], forceRender?: boolean = true) => void
mergeCells合并单元格(cellsInfo?: MergedCellInfo[], hideData?: boolean) => void
unmergeCell取消合并单元格(removedCell: MergedCell) => void
updateAllDataCells更新所有数值单元格() => void
updateCells更新指定单元格(cells: S2CellType[]) => void
addIntercepts新增交互拦截(interceptTypes: InterceptType[]) => void
hasIntercepts是否有指定拦截的交互(interceptTypes: InterceptType[]) => boolean
removeIntercepts移除指定交互拦截(interceptTypes: InterceptType[]) => void
highlightNodes高亮节点对应的单元格(nodes: Node[], stateName: InteractionStateName) => void
scrollTo滚动至指定位置(offsetConfig: ScrollOffsetConfig) => void
scrollToNode滚动至指定单元格节点(node: Node, options?: CellScrollToOptions) => void
scrollToCell滚动至指定单元格(cell: S2CellType, options?: CellScrollToOptions) => void
scrollToCellById滚动至指定单元格 id 对应的位置,如果不在可视化范围内,则会自动滚动(id: string, options?: CellScrollToOptions) => void
scrollToTop滚动至顶部(options?: CellScrollToOptions) => void
scrollToRight滚动至右边(options?: CellScrollToOptions) => void
scrollToBottom滚动至底部(options?: CellScrollToOptions) => void
scrollToLeft滚动至左边(options?: CellScrollToOptions) => void
highlightCell高亮指定单元格(可视范围内)(cell: S2CellType) => void
selectCell选中指定单元格(可视范围内)(cell: S2CellType, options: ChangeCellOptions) => void
changeCell改变指定单元格状态(可视范围内)(如:选中/高亮/多选等)(cell: S2CellType, options: ChangeCellOptions) => void
updateDataCellRelevantHeaderCells高亮数值单元格和所对应行列单元格(stateName: InteractionStateName, meta: ViewMeta) => void
updateDataCellRelevantRowCells高亮数值单元格和所对应行头单元格(stateName: InteractionStateName, meta: ViewMeta) => void
updateDataCellRelevantColCells高亮数值单元格和所对应列头单元格(stateName: InteractionStateName, meta: ViewMeta) => void
Interaction
Copy

功能描述:单元格复制。查看 文档 和 示例

参数说明类型默认值必选
enable是否允许复制booleantrue
withFormat是否使用 s2DataConfig 的 formatter 格式复制数据booleantrue
withHeader复制数据是否带表头信息booleanfalse
customTransformer复制时支持自定义 (transformer) 数据格式化方法(transformer: Transformer) => Partial<Transformer>transformer
CustomInteraction
ScrollSpeedRatio
ResizeInteractionOptions
BrushSelection
CellSelectedDetail
InterceptType
InteractionName
InteractionStateName
CellType
CellScrollToOptions
ChangeCellOptions
ScrollOffsetConfig
ScrollOffset
InteractionConstructor
BaseEvent
S2CellType
ChangeCellOptions
MergedCellInfo
CellMeta
InteractionStateInfo
EventController
EventListener
S2EventHandler
EventHandler
ViewMeta
HeaderActionIcon
HeaderActionIconProps
CustomSVGIcon