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

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; 

type RawData = Record<string, DataItem>;