spreadsheet.zh.md

title	order
SpreadSheet	1

功能描述：表格实例相关属性和方法。详情

const s2 = new PivotSheet()

s2.isPivotMode()

参数	说明	类型	版本
dom	挂载的容器节点	string | HTMLElement
theme	主题配置	S2Theme
store	存储的一些信息	Store
dataCfg	数据配置	S2DataConfig
options	表格配置	S2Options
dataSet	表格数据集 （字段，数据，排序）	BaseDataSet
facet	当前可视渲染区域	BaseFacet
tooltip	tooltip	BaseTooltip
container	g-canvas 实例	Canvas
backgroundGroup	背景颜色区域 group	Group
foregroundGroup	背景颜色区域 group	Group
panelGroup	可视范围单元格区域 group	Group
panelScrollGroup	可视范围单元格滚动区域 group	Group
frozenRowGroup	行头冻结区域 group	Group
frozenColGroup	列头冻结区域 group	Group
frozenTrailingRowGroup	行头底部冻结区域 group	Group
frozenTrailingColGroup	列头底部冻结区域 group	Group
frozenTopGroup	顶部冻结区域 group	Group
frozenBottomGroup	底部冻结区域 group	Group
interaction	交互	Interaction
hdAdapter	高清适配	HdAdapter
on	事件订阅	(event: S2Event, listener: () => void) => void
emit	事件发布	(event: S2Event, ...args: any[]) => void
getDataSet	获取数据集	(options: S2Options) => BaseDataSet
isPivotMode	是否是透视表	() => boolean
isHierarchyTreeType	是否是树状结构	() => boolean
isScrollContainsRowHeader	是否是包含行头的滚动	() => boolean
isFrozenRowHeader	是否是冻结行头状态	() => boolean
isTableMode	是否是明细表	() => boolean
isValueInCols	是否是数值置于行头	() => boolean
clearDrillDownData	清除下钻数据	(rowNodeId?: string) => void
showTooltip	显示 tooltip	(showOptions: TooltipShowOptions) => void
showTooltipWithInfo	显示 tooltip, 并且展示一些默认信息	(event: CanvasEvent | MouseEvent, data: TooltipData[], options?: TooltipOptions) => void
hideTooltip	隐藏 tooltip	() => void
destroyTooltip	销毁 tooltip	() => void
registerIcons	注册 自定义 svg 图标 （根据 options.customSVGIcons)	() => void
setDataCfg	更新数据配置	(dataCfg: S2DataConfig, reset?: boolean ) => void	reset 参数需在 @antv/s2-v1.34.0版本使用
setOptions	更新表格配置	(options: S2Options, reset?: boolean) => void	reset 参数需在 @antv/s2-v1.34.0版本使用
render	重新渲染表格，如果 reloadData = true, 则会重新计算数据，reBuildDataSet = true, 重新构建数据集，reBuildHiddenColumnsDetail = true 重新构建隐藏列信息	(reloadData?: boolean, { reBuildDataSet?: boolean; reBuildHiddenColumnsDetail?: boolean }) => void
destroy	销毁表格	() => void
setThemeCfg	更新主题配置 （含主题 schema, 色板，主题名）	(themeCfg: ThemeCfg) => void
setTheme	更新主题 （只包含主题 scheme)	(theme: S2Theme) => void
updatePagination	更新分页	(pagination: Pagination) => void
getContentHeight	获取当前表格实际内容高度	() => number
changeSheetSize （别名：changeSize)	修改表格画布大小，不用重新加载数据	(width?: number, height?: number) => void
getLayoutWidthType	获取单元格宽度布局类型（LayoutWidthType: adaptive（自适应） | colAdaptive（列自适应） | compact（紧凑））	() => LayoutWidthType
getRowNodes	获取行头节点	(level: number) => Node[]
getRowLeafNodes	获取行头叶子节点	() => Node[]
getColumnNodes	获取列头节点	(level: number) => Node[]
getColumnLeafNodes	获取列头叶子节点	() => Node[]
updateScrollOffset	更新滚动偏移	(config: OffsetConfig) => void
getCell	根据 event.target 获取当前 单元格	(target: EventTarget) => S2CellType
getCellType	根据 event.target 获取当前 单元格类型	(target: EventTarget) => CellTypes
getTotalsConfig	获取总计小计配置	(dimension: string) => Total
getInitColumnLeafNodes	获取初次渲染的列头叶子节点 （比如：隐藏列头前）	() => Node[]
getCanvasElement	获取表格对应的 <canvas/> HTML 元素	() => HTMLCanvasElement
clearColumnLeafNodes	清空存储在 store 中的初始叶子节点	() => void
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

S2MountContainer

type S2MountContainer = string | HTMLElement;

OffsetConfig

功能描述：滚动偏移配置

interface OffsetConfig {
  rowHeaderOffsetX?: {
    value: number | undefined;
    animate?: boolean;
  };
  offsetX?: {
    value: number | undefined;
    animate?: boolean;
  };
  offsetY?: {
    value: number | undefined;
    animate?: boolean;
  };
}

CellTypes

功能描述：单元格类型

export enum CellTypes {
  DATA_CELL = 'dataCell',  // 数值单元格
  HEADER_CELL = 'headerCell', // 行列头单元格
  ROW_CELL = 'rowCell', // 行头单元格
  COL_CELL = 'colCell', // 列头单元格
  CORNER_CELL = 'cornerCell', // 角头单元格
  MERGED_CELL = 'mergedCell', // 合并后的单元格
}

BBox

功能描述：盒模型

type BBox = {
  x: number;
  y: number;
  minX: number;
  minY: number;
  maxX: number;
  maxY: number;
  width: number;
  height: number;
};