API
表格参数配置
const s2Options = {
width: 600,
height: 400,
hierarchyType: 'grid'
}
参数 | 类型 | 必选 | 默认值 | 功能描述 | 版本 |
---|---|---|---|---|---|
width | number | 600 | 表格宽度 | ||
height | number | 480 | 表格高度 | ||
debug | boolean | false | 是否开启调试模式 | ||
hierarchyType | "grid" | "tree" | grid | 行头的展示方式,grid:平铺网格结构, tree: 树状结构。 支持 自定义结构 | ||
conditions | Conditions | 字段标记,条件格式配置 | |||
totals | Totals | 小计总计配置 | |||
tooltip | Tooltip | tooltip 配置 | |||
interaction | Interaction | 表格交互配置 | |||
pagination | Pagination | 分页配置 | |||
frozen | Frozen | 行列头冻结配置 | |||
seriesNumber | SeriesNumber | 序号列展示及自定义文字配置 | |||
showDefaultHeaderActionIcon | boolean | true | 是否展示默认行列头操作图标 | ||
headerActionIcons | HeaderActionIcon[] | false | 自定义行列头操作图标(需要将 showDefaultHeaderActionIcon 置为 false ) | ||
customSVGIcons | CustomSVGIcon[] | false | 自定义 svg 图标 | ||
style | Style | 单元格样式设置,比如布局类型,宽高,边距,是否隐藏数值列头等 | |||
hd | boolean | true | 是否开启高清屏适配,解决多屏切换,高清视网膜屏字体渲染模糊的问题。查看更多 | ||
mergedCellsInfo | MergedCellInfo[][] | 合并单元格信息 | |||
placeholder | string | (meta: Record<string, any>) => string | 自定义单元格空数据占位符 | |||
cornerText | string | 自定义角头文本 (仅在树状模式有效) | |||
cornerExtraFieldText | string | 数值 | 自定义角头虚拟数值字段文本("数值挂行头"时有效) | ||
dataCell | DataCellCallback | 自定义单元格 cell | |||
cornerCell | CellCallback | 自定义 cornerCell | |||
rowCell | CellCallback | 自定义行头 cell | |||
colCell | CellCallback | 自定义列头 cell | |||
mergedCell | MergedCellCallback | 自定义合并单元格 | |||
frame | FrameCallback | 自定义表格框架/边框 | |||
cornerHeader | CornerHeaderCallback | 自定义角头 | |||
layoutHierarchy | LayoutHierarchy | 自定义层级结构 | |||
layoutArrange | LayoutArrange | 自定义排列顺序 (树状模式有效) | |||
layoutCoordinate | layoutCoordinate | 自定义单元格节点坐标 | |||
layoutCellMeta | layoutCellMeta | 自定义单元格元数据 | |||
layoutSeriesNumberNodes | LayoutSeriesNumberNodes | 自定义序号节点 | |||
dataSet | DataSet | 自定义数据集 | |||
facet | (spreadsheet: SpreadSheet) => BaseFacet | 自定义分面 | |||
transformCanvasConfig | (renderer: Renderer, spreadsheet: SpreadSheet) => Partial<CanvasConfig> | void | - | 自定义 AntV/G 渲染引擎 配置参数 & 插件注册 |