功能描述：交互配置。查看 文档 和 示例

参数	说明	类型	默认值	必选
linkFields	标记字段为链接样式，用于外链跳转	string[] | (meta: Node | ViewMeta) => boolean
selectedCellsSpotlight	是否开启选中高亮聚光灯效果	boolean	false
hoverHighlight	鼠标悬停时高亮当前单元格，以及所对应的行头，列头	boolean	true
hoverFocus	鼠标悬停在当前单元格超过默认 800ms 后，保持当前高亮，显示 tooltip，悬停时间通过设置 duration 来控制	boolean | {duration: number}	true
hiddenColumnFields	用于配置默认隐藏的列，透视表 和多列头明细表 需要配置列头唯一 id, 单列头明细表 配置列头 field 字段即可 （即：s2DataConfig.fields.columns). 了解更多	string[]
copy	单元格复制配置	Copy
customInteractions	自定义交互 详情	CustomInteraction[]
scrollSpeedRatio	用于控制滚动速率，分水平和垂直两个方向，默认为 1	ScrollSpeedRatio
autoResetSheetStyle	用于控制点击表格外区域和按下 ESC 键时是否重置交互状态和关闭 Tooltip, 支持根据 event 动态判断	boolean | (event: Event | FederatedPointerEvent, spreadsheet: SpreadSheet) => boolean	true
resize	用于控制 resize 热区是否显示	boolean | ResizeInteractionOptions	true
brushSelection	是否允许单元格（包含行头，列头，数值单元格）刷选。行头，列头刷选只支持透视表	boolean | BrushSelection	true
multiSelection	是否允许多选 （包含行头，列头，数值单元格）	boolean	true
rangeSelection	是否允许区间快捷多选	boolean	true
scrollbarPosition	用于控制滚动条展示在内容区边缘还是画布边缘	content | canvas	content
eventListenerOptions	事件监听函数 addEventListener 的 可选项配置, 可控制事件从冒泡阶段还是捕获阶段触发	false
selectedCellHighlight	选中数值单元格后的行列高亮联动 rowHeader：选中数值单元格后高亮对应行头 colHeader：选中数值单元格后高亮对应列头 currentRow：选中数值单元格后高亮整行 currentCol：选中数值单元格后高亮整列 true：同 { rowHeader: true, colHeader: true, currentRow: true, currentCol: true }	boolean | { rowHeader?: boolean, colHeader?: boolean, currentRow?: boolean, currentCol?: boolean }	false
overscrollBehavior	控制滚动至边界的行为，可禁用浏览器的默认滚动行为。详情	auto | contain | none | null	auto

Copy

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

参数	说明	类型	默认值	必选
enable	是否允许复制	boolean	true
withFormat	是否使用 s2DataConfig 的 formatter 格式复制数据	boolean	true
withHeader	复制数据是否带表头信息	boolean	false
customTransformer	复制时支持自定义 (transformer) 数据格式化方法	(transformer: Transformer) => Partial<Transformer>	transformer

CustomInteraction

功能描述：自定义交互，继承 BaseEvent: 查看示例

参数	说明	类型	默认值	必选
key	交互的唯一标识	string		✓
interaction	交互实例	InteractionConstructor		✓

ScrollSpeedRatio

功能描述：滚动速率配置。查看示例

interface ScrollSpeedRatio { 
  horizontal?: number; // 水平滚动速率，默认为 1 
  vertical?: number; // 垂直滚动速率，默认为 1 
} 

ResizeInteractionOptions

功能描述：宽高调整配置。查看示例

参数	说明	类型	默认值	必选
rowCellVertical	是否开启行头垂直方向 resize 热区	boolean	true
cornerCellHorizontal	是否开启角头水平方向 resize 热区	boolean	true
colCellHorizontal	是否开启列头水平方向 resize 热区	boolean	true
colCellVertical	是否开启列头垂直方向 resize 热区 （列头隐藏时该配置无效）	boolean	true
rowResizeType	用于控制行高 resize 时的生效范围 1. all: 对所有单元格生效（会覆盖默认的行高配置），2. current: 对当前单元格生效，3. selected: 对当前单元格生效，如果单元格是多选状态，调整任意选中单元格，对所有选中的生效。	all| current | selected	current
colResizeType	用于控制列宽 resize 时的生效范围 1. all: 对所有单元格生效（会覆盖默认的列宽配置），2. current: 对当前单元格生效，3. selected: 对当前单元格生效，如果单元格是多选状态，调整任意选中单元格，对所有选中的生效。	all| current | selected	current
disable	用于控制行高 resize 是否生效。查看示例	(resizeInfo: S2CellType) => boolean
visible	自定义当前单元格是否显示 resize 热区	(cell: S2CellType) => boolean
minCellWidth	单元格可拖拽最小宽度	number	40
minCellHeight	单元格可拖拽最小高度	number	20

BrushSelection

功能描述：单元格刷选配置。查看示例

参数	说明	类型	默认值	必选
dataCell	是否允许数值单元格刷选	boolean	true
rowCell	是否允许行头单元格刷选（仅支持透视表）	boolean	false
colCell	是否允许列头单元格刷选	boolean	false

CellSelectedDetail

功能描述：单元格选中信息明细。

参数	说明	类型	默认值	必选
interactionName	触发选中的交互名	InteractionName
targetCell	触发选中的单元格	S2CellType
event	触发选中的事件对象	FederatedPointerEvent | Event | KeyboardEvent

InterceptType

功能描述：交互拦截类型。

enum InterceptType { 
  HOVER = 'hover', 
  CLICK = 'click', 
  DATA_CELL_BRUSH_SELECTION = 'dataCellBrushSelection', 
  ROW_CELL_BRUSH_SELECTION = 'rowCellBrushSelection', 
  COL_CELL_BRUSH_SELECTION = 'colCellBrushSelection', 
  MULTI_SELECTION = 'multiSelection', 
  RESIZE = 'resize', 
} 

InteractionName

功能描述：交互名称。

enum InteractionName { 
  CORNER_CELL_CLICK = 'cornerCellClick', 
  DATA_CELL_CLICK = 'dataCellClick', 
  ROW_CELL_CLICK = 'rowCellClick', 
  COL_CELL_CLICK = 'colCellClick', 
  MERGED_CELLS_CLICK = 'mergedCellsClick', 
  ROW_COLUMN_CLICK = 'rowColumnClick', 
  HEADER_CELL_LINK_CLICK = 'headerCellLinkClick', 
  HOVER = 'hover', 
  DATA_CELL_BRUSH_SELECTION = 'dataCellBrushSelection', 
  ROW_CELL_BRUSH_SELECTION = 'rowCellBrushSelection', 
  COL_CELL_BRUSH_SELECTION = 'colCellBrushSelection', 
  COL_ROW_RESIZE = 'rowColResize', 
  DATA_CELL_MULTI_SELECTION = 'dataCellMultiSelection', 
  ROW_CELL_MULTI_SELECTION = 'rowCellMultiSelection', 
  COL_CELL_MULTI_SELECTION = 'colCellMultiSelection', 
  RANGE_SELECTION = 'rangeSelection', 
  SELECTED_CELL_MOVE = 'selectedCellMove', 
  GLOBAL_RESET = 'globalReset', 
} 

InteractionStateName

功能描述：交互状态名称。

enum InteractionStateName { 
  ALL_SELECTED = 'allSelected', 
  SELECTED = 'selected', 
  ROW_CELL_BRUSH_SELECTED = 'rowCellBrushSelected', 
  COL_CELL_BRUSH_SELECTED = 'colCellBrushSelected', 
  DATA_CELL_BRUSH_SELECTED = 'dataCellBrushSelected', 
  UNSELECTED = 'unselected', 
  HOVER = 'hover', 
  HOVER_FOCUS = 'hoverFocus', 
  HIGHLIGHT = 'highlight', 
  SEARCH_RESULT = 'searchResult', 
  PREPARE_SELECT = 'prepareSelect', 
} 

CellType

功能描述：单元格类型。

enum CellType { 
  DATA_CELL = 'dataCell', 
  ROW_CELL = 'rowCell', 
  COL_CELL = 'colCell', 
  SERIES_NUMBER_CELL = 'seriesNumberCell', 
  CORNER_CELL = 'cornerCell', 
  MERGED_CELL = 'mergedCell', 
}