S2

功能描述：表格数据集。详情

s2.dataSet.getFieldName('type')

参数	说明	类型	版本
fields	字段信息	Fields
meta	字段元信息，包含有字段名、格式化等	Meta[]
originData	原始数据	RawData
indexesData	多维索引数据	Record<string, RawData[][] \| RawData[]>
sortParams	排序配置	SortParams
filterParams	筛选配置	FilterParam[]
displayData	展示数据	RawData[]
spreadsheet	表格实例	SpreadSheet
getField	获取字段	(field: CustomHeaderField) => Meta
getFieldMeta	获取字段元数据信息	(field: CustomHeaderField, meta?: Meta[]) => Meta
getFieldName	获取字段名	(field: CustomHeaderField, defaultValue?: string) => `string`
getCustomRowFieldName	获取自定义单元格字段名称	(cell: S2CellType<`ViewMeta` \| `Node`>) => `string`
getCustomFieldDescription	获取自定义单元格字段描述	(cell: S2CellType<`ViewMeta` \| `Node`>) => `string`
getFieldFormatter	获取字段格式化函数	(field: CustomHeaderField) => Formatter
getFieldDescription	获取字段描述	(field: CustomHeaderField) => Formatter
setDataCfg	设置数据配置	`<T extends boolean = false>(dataCfg: T extends true ?` `S2DataConfig` `: Partial<S2DataConfig>, reset?: T) => void`	`reset` 参数需在 `@antv/s2^1.34.0`版本使用
getDisplayDataSet	获取当前显示的数据集	() => DataType[]
getDimensionValues	获取维值	(filed: string, query?: DataType ) => string[]
getCellData	获取单个的单元格数据	(params: GetCellDataParams) => DataType[]
getCellMultiData	获取批量的单元格数据	(params?: GetCellMultiDataParams) => DataType[]
moreThanOneValue	是否超过 1 个数值	() => ViewMeta
isEmpty	是否为空数据集	() => `boolean`
displayFormattedValueMap	单元格所对应格式化后的值（用于编辑表）	`Map<string, string>`
getValueRangeByField	获取数值最大最小值区间	`(field: string) => { minValue: number, maxValue: number }`

Formatter

type Formatter = (
  value: DataItem,
  data?: DataItem | ViewMetaData | ViewMetaData[],
  meta?: Node | ViewMeta | null | undefined,
) => SimpleData;

FormatResult

interface FormatResult {
  formattedValue: SimpleData;
  value: DataItem;
}

TotalSelection

type TotalSelection = {
  grandTotalOnly?: boolean;
  subTotalOnly?: boolean;
  totalDimensions?: boolean | string[];
};

type TotalSelectionsOfMultiData = {
  row?: TotalSelection;
  column?: TotalSelection;
};

Query

type Query = Record<string, any>;

TotalStatus

interface TotalStatus {
  isRowTotal: boolean;
  isRowSubTotal: boolean;
  isColTotal: boolean;
  isColSubTotal: boolean;
}

GetCellDataParams

interface GetCellDataParams {
  /**
   * 查询条件
   */
  query: Query;

  /**
   * 是否是汇总节点
   */
  isTotals?: boolean;

  /**
   * 行头节点，用于下钻场景
   */
  rowNode?: Node;

  /**
   * 是否是行头
   */
  isRow?: boolean;

  /**
   * 汇总信息
   */
  totalStatus?: TotalStatus;
}

GetCellMultiDataParams

interface GetCellMultiDataParams {
  /**
   * 查询条件
   */
  query?: Query;

  /**
   * 查询类型
   */
  queryType?: QueryDataType;

  /**
   * 下钻
   */
  drillDownFields?: string[];
}

enum QueryDataType {
  All = 'all', // 获取所有的数据
  DetailOnly = 'detailOnly', // 只需要明细数据
}

FilterParam

interface FilterParam {
  filterKey: string;
  filteredValues?: unknown[];
  customFilter?: (row: Query) => boolean;
}

CustomTreeNode

功能描述：自定义树状结构的配置，适用于透视表和明细表的自定义行列头。查看文档和示例

参数	说明	类型	默认值	必选
field	当前节点唯一标识	`string`		✓
title	当前节点展示名	`string`		✓
collapsed	节点是否收起（树状模式下，行头非叶子节点有效）	`boolean`	`false`
description	节点的额外描述信息，在对应行头的 tooltip 中展示	`string`
children	子节点	CustomTreeNode[]

CustomHeaderField

type CustomHeaderField = CustomTreeNode | string;

CustomTreeNode

功能描述：自定义树状结构的配置，适用于透视表和明细表的自定义行列头。查看文档和示例

参数	说明	类型	默认值	必选
field	当前节点唯一标识	`string`		✓
title	当前节点展示名	`string`		✓
collapsed	节点是否收起（树状模式下，行头非叶子节点有效）	`boolean`	`false`
description	节点的额外描述信息，在对应行头的 tooltip 中展示	`string`
children	子节点	CustomTreeNode[]

CustomHeaderField

type CustomHeaderField = CustomTreeNode | string;

ViewMeta

功能描述：数值单元格数据和位置等信息

参数	类型	功能描述
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

RawData

DateItem

type RawData = Record<string, DataItem>;

SimpleData

type SimpleData = string | number | null | undefined;

MultiData

功能描述：用于支持多指标类型的自定义数据单元格渲染。例如：趋势分析表

配置项名称	说明	类型	默认值	必选
`values`	格式化后的数据，直接展示在 dataCfg 中	SimpleData[][]		✓
`originalValues`	原始数据，用于原始数据导出	SimpleData[][]
`label`	用作单元格小标题，单独占一行展示	`string`
`[key: string]`	其他透传字段，用于自定义单元格的定制化展示	`unknown`	``

{
  "number": {
    "originalValues": [1, 2, 3],
    "values": ["1", "2", "3"]
  }
}

DataItem

SimpleData | MultiData | MiniChartData

type DataItem = SimpleData | MultiData | MiniChartData | Record<string, unknown>;

{
  "number": 7789,
  "province": "浙江省",
  "city": "杭州市",
  "type": "家具",
  "sub_type": "桌子"
}

ExtraData

import type { EXTRA_FIELD, VALUE_FIELD } from '@antv/s2';

type ExtraData = {
  [EXTRA_FIELD]: string;
  [VALUE_FIELD]: string | DataItem;
};

{
  "$$extra$$": "number",
  "$$value$$": 7789,
}

Data

type Data = RawData & ExtraData;

ViewMetaData

查看 CellData 定义

type ViewMetaData = Data | CellData;

Data

{
  "city": "杭州市"
}

CellData

{
  "extraField": "number",
  "raw": {
    "number": 7789,
    "province": "浙江省",
    "city": "杭州市",
    "type": "家具",
    "sub_type": "桌子"
  },
  "$$extra$$": "number",
  "$$value$$": 7789,
  "$$origin$$": {
    "number": 7789,
    "province": "浙江省",
    "city": "杭州市",
    "type": "家具",
    "sub_type": "桌子"
  }
}

MiniChartData

功能描述：在单元格内绘制 mini 图（支持折线图、子弹图、柱状图）. 查看文档和示例

BaseChartData

功能描述：内置折线图、柱状图数据配置项，数据格式参考 G2

参数	说明	类型	必选
type	mini 图类型	`line \| bar`	✓
encode	编码方式，声明 x 位置通道或 y 位置通道绑定的对应的列数据	`{x: string; y: string}`	✓
data	原始数据	Data[]	✓
[key: string]	其他透传字段，用于自定义单元格的定制化展示	`unknown`

BulletValue

功能描述：内置子弹图数据配置项

参数	说明	类型	必选	默认值
type	mini 图类型	`bullet`	✓	`bullet`
measure	当前指标	`number \| string`	✓
target	目标值	`number \| string`	✓
[key: string]	其他透传字段，用于自定义单元格的定制化展示	`unknown`

BaseDataSet

Formatter

FormatResult

TotalSelection

Query

TotalStatus

GetCellDataParams

GetCellMultiDataParams

FilterParam

CustomTreeNode

CustomHeaderField

CustomTreeNode

CustomHeaderField

ViewMeta

RawData

SimpleData

MultiData

DataItem

ExtraData

Data

ViewMetaData

Data

CellData

MiniChartData

BaseChartData

BulletValue