Store
上一篇
Interaction
下一篇
BaseCell
Loading...
功能描述：存储一些信息。详情
s2.store.get('key') // 获取s2.store.set('key', value) // 存储
| 参数 | 说明 | 类型 |
|---|---|---|
| scrollX | 水平滚动偏移 | number |
| scrollY | 垂直滚动偏移 | number |
| rowHeaderScrollX | 行头水平滚动偏移 | number |
| sortParam | 列头排序配置 | SortParam |
| drillDownIdPathMap | 下钻节点 id 和对应生成的 path 寻址路径 | Map<string, number[][]> |
| drillDownNode | 当前下钻节点 | Node |
| drillItemsNum | 下钻数据的个数控制 | number |
| interactionStateInfo | 当前交互状态信息 | number |
| drillDownFieldInLevel | 下钻节点层级信息 | PartDrillDownInfo[] |
| originalDataCfg | 原始数据配置 | S2DataConfig |
| panelBBox | 可视区域包裹盒模型 | BBox |
| activeResizeArea | 当前调整大小区域 group | Group |
| valueRanges | 条件格式值区间 | ValueRanges |
| initColLeafNodes | 初次渲染时的列头叶子节点 | Node[] |
| hiddenColumnsDetail | 隐藏的列头详情 | HiddenColumnsInfo[] |
| lastRenderedColumnFields | 上一次渲染的列头配置 | string[] |
| resized | 是否手动调整过宽高 | boolean |
| visibleActionIcons | hover 显示的 icon 缓存 | GuiIcon[] |
| lastClickedCell | 上一次点击的单元格 | S2CellType<ViewMeta> |
| initOverscrollBehavior | 初始滚动链状态 | 'auto' | 'none' | 'contain' |
| sortMethodMap | 排序方式 | Record<string, SortMethod> |
| [key: string] | 其他任意字段 | unknown |
interface HiddenColumnsInfo {// 当前显示的兄弟节点之前所隐藏的节点hideColumnNodes: Node[];// 当前隐藏列所对应展示展开按钮的兄弟节点displaySiblingNode: Node;}
interface PartDrillDownInfo {// 下钻数据drillData: RawData[];// 下钻字段drillField: string;}
export interface ValueRange {minValue?: number;maxValue?: number;}export type ValueRanges = Record<string, ValueRange>;
功能描述：数值单元格数据和位置等信息
| 参数 | 类型 | 必选 | 默认值 | 功能描述 |
|---|---|---|---|---|
| spreadsheet | SpreadSheet | 表格实例 | ||
| id | string | 单元格唯一标识 | ||
| x | number | 单元格 x 坐标 | ||
| y | number | 单元格 y 坐标 | ||
| width | number | 单元格宽度 | ||
| height | number | 单元格高度 | ||
| data | ViewMetaData | 单元格数据 | ||
| rowIndex | number | 单元格在行叶子节点中的索引 | ||
| colIndex | number | 单元格在列叶子节点中的索引 | ||
| valueField | string | 度量 id | ||
| fieldValue | DataItem | 度量展示的真实值 | ||
| isTotals | boolean | 是否为总计：true 为总计 false 为小计 | ||
| query | Record<string, any> | 行列查询条件 | ||
| rowQuery | Record<string, any> | 行查询条件 | ||
| colQuery | Record<string, any> | 列查询条件 | ||
| rowId | string | 单元格的行 id | ||
| colId | string | 单元格的列 id |
type RawData = Record<string, DataItem>;
type SimpleData = string | number | null | undefined;
功能描述：用于支持多指标类型的自定义数据单元格渲染。例如：趋势分析表
| 配置项名称 | 说明 | 类型 | 默认值 | 必选 |
|---|---|---|---|---|
values | 格式化后的数据，直接展示在 dataCfg 中 | SimpleData[][] | ✓ | |
originalValues | 原始数据，用于原始数据导出 | SimpleData[][] | ||
label | 用作单元格小标题，单独占一行展示 | string | ||
[key: string] | 其他透传字段，用于自定义单元格的定制化展示 | unknown | `` |
{"number": {"originalValues": [1, 2, 3],"values": ["1", "2", "3"]}}
SimpleData | MultiData | MiniChartData
type DataItem = SimpleData | MultiData | MiniChartData | Record<string, unknown>;
{"number": 7789,"province": "浙江省","city": "杭州市","type": "家具","sub_type": "桌子"}
import type { EXTRA_FIELD, VALUE_FIELD } from '@antv/s2';type ExtraData = {[EXTRA_FIELD]: string;[VALUE_FIELD]: string | DataItem;};
{"$$extra$$": "number","$$value$$": 7789,}
type Data = RawData & ExtraData;
CellData 定义type ViewMetaData = Data | CellData;
{"city": "杭州市"}
{"extraField": "number","raw": {"number": 7789,"province": "浙江省","city": "杭州市","type": "家具","sub_type": "桌子"},"$$extra$$": "number","$$value$$": 7789,"$$origin$$": {"number": 7789,"province": "浙江省","city": "杭州市","type": "家具","sub_type": "桌子"}}
功能描述：在单元格内绘制 mini 图（支持 折线图、子弹图、柱状图）. 查看 文档 和 示例
功能描述：内置折线图、柱状图数据配置项，数据格式参考 G2
| 参数 | 说明 | 类型 | 必选 | 默认值 |
|---|---|---|---|---|
| type | mini 图类型 | line | bar | ✓ | |
| encode | 编码方式，声明 x 位置通道或 y 位置通道绑定的对应的列数据 | {x: string; y: string} | ✓ | |
| data | 原始数据 | Data[] | ✓ | |
| [key: string] | 其他透传字段，用于自定义单元格的定制化展示 | unknown |
功能描述：内置子弹图数据配置项
| 参数 | 说明 | 类型 | 必选 | 默认值 |
|---|---|---|---|---|
| type | mini 图类型 | bullet | ✓ | bullet |
| measure | 当前指标 | number | string | ✓ | |
| target | 目标值 | number | string | ✓ | |
| [key: string] | 其他透传字段，用于自定义单元格的定制化展示 | unknown |