API

Function description: tabular data set. details

s2.dataSet.getFieldName('type') 
parameterillustratetypeVersion
fieldsfield information() => Fields
metaField meta information, including field name, formatting, etc.() => Meta[]
originDataRaw data() => DataType[]
totalDatasummary data() => DataType[]
indexesDatamultidimensional index data() => DataType[]
sortParamssort configuration() => SortParams
spreadsheetForm example() => SpreadSheet
getFieldMetaGet field metadata information(field: string, meta?: Meta[] ) => Meta
getFieldNameget field name() => string
getFieldFormatterGet the field formatting function() => (v: string) => unknown
getFieldDescriptionGet field description() => string
setDataCfgSet data configuration<T extends boolean = false>(dataCfg: T extends true ? S2DataConfig : Partial<S2DataConfig>, reset?: T) => voidThe reset parameter needs to be used in @antv/s2^1.34.0 version
getDisplayDataSetGet the currently displayed dataset() => DataType[]
getDimensionValuesget dimension value(filed: string, query?: DataType ) => string[]
getCellDataGet a single cell data(params: CellDataParams ) => DataType[]
getMultiDataGet bulk cell data(query: DataType,params?: MultiDataParams) => DataType[]
getMultiData(deprecated)Get bulk cell data(query: DataType , isTotals?: boolean, isRow?: boolean, drillDownFields?: string[], includeTotalData:boolean) => DataType[]
moreThanOneValueIs there more than 1 value() => ViewMeta
DataType
type DataType = Record<string, unknown>; 
CellDataParams
MultiDataParams