S2

功能描述：透视表数值单元格元数据。详情

this.meta.data

参数	说明	类型
extraField	`string`	虚拟度量字段
raw	原始数据	RawData
getValueByField	获取数值	(field: `string`) => DataItem
$$value$$	指标值（内部使用）	DataItem
$$extra$$	虚拟度量字段（内部使用，等价于 `extraField`)	`string`
$$origin$$	原始数据（内部使用，等价于 `raw`)	RawData

静态方法

import { CellData } from '@antv/s2'

getCellData

CellData.getCellData(raw: RawData, extraField: string)

getCellDataList

CellData.getCellDataList(raw: RawData, extraFields: string[])

getFieldValue

CellData.getFieldValue(data: ViewMetaData, field?: 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`

功能描述：透视表数值单元格元数据。详情

this.meta.data

参数	说明	类型
extraField	`string`	虚拟度量字段
raw	原始数据	RawData
getValueByField	获取数值	(field: `string`) => DataItem
$$value$$	指标值（内部使用）	DataItem
$$extra$$	虚拟度量字段（内部使用，等价于 `extraField`)	`string`
$$origin$$	原始数据（内部使用，等价于 `raw`)	RawData

静态方法

import { CellData } from '@antv/s2'

getCellData

CellData.getCellData(raw: RawData, extraField: string)

getCellDataList

CellData.getCellDataList(raw: RawData, extraFields: string[])

getFieldValue

CellData.getFieldValue(data: ViewMetaData, field?: 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`