Skip to content

Commit

Permalink
docs: 加个空格
Browse files Browse the repository at this point in the history
  • Loading branch information
JuZe committed Oct 19, 2023
1 parent 706a74b commit 0a0fa17
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
38 changes: 19 additions & 19 deletions s2-site/docs/api/basic-class/base-data-set.en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,25 @@ Function description: tabular data set. [details](https://github.com/antvis/S2/b
s2.dataSet.xx()
```

| parameter | illustrate | type | Version |
| ------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------- |
| fields | field information | () => [Fields](/docs/api/general/S2DataConfig#fields) | |
| meta | Field meta information, including field name, formatting, etc. | () => [Meta\[\]](/docs/api/general/S2DataConfig#meta) | |
| originData | Raw data | () => [DataType\[\]](#datatype) | |
| totalData | summary data | () => [DataType\[\]](#datatype) | |
| indexesData | multidimensional index data | () => [DataType\[\]](#datatype) | |
| sortParams | sort configuration | () => [SortParams](/docs/api/general/S2DataConfig#sortparams) | |
| spreadsheet | Form example | () => [SpreadSheet](/docs/api/basic-class/spreadsheet) | |
| getFieldMeta | Get field metadata information | (field: string, meta?: [Meta\[\]](/docs/api/general/S2DataConfig#meta) ) => [Meta](/docs/api/general/S2DataConfig#meta) | |
| getFieldName | get field name | `() => string` | |
| getFieldFormatter | Get the field formatting function | `() => (v: string) => unknown` | |
| getFieldDescription | Get field description | `() => string` | |
| setDataCfg | Set data configuration | `<T extends boolean = false>(dataCfg: T extends true ?` [`S2DataConfig`](/docs/api/general/S2DataConfig) `: Partial<`[`S2DataConfig`](/docs/api/general/S2DataConfig)`>, reset?: T) => void` | The `reset` parameter needs to be used in `@antv/s2-v1.34.0` version |
| getDisplayDataSet | Get the currently displayed dataset | () => [DataType\[\]](#datatype) | |
| getDimensionValues | get dimension value | (filed: string, query?: [DataType](#datatype) ) => string\[] | |
| getCellData | Get a single cell data | (params: [CellDataParams](#celldataparams) ) => [DataType\[\]](#datatype) | |
| getMultiData | Get bulk cell data | (query: [DataType](#datatype) , isTotals?: boolean, isRow?: boolean, drillDownFields?: string\[],includeTotalData:boolean) => [DataType\[\]](#datatype) | |
| moreThanOneValue | Is there more than 1 value | () => [ViewMeta](#viewmeta) | |
| parameter | illustrate | type | Version |
| ------------------- | -------------------------------------------------------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -------------------------------------------------------------------- |
| fields | field information | () => [Fields](/docs/api/general/S2DataConfig#fields) | |
| meta | Field meta information, including field name, formatting, etc. | () => [Meta\[\]](/docs/api/general/S2DataConfig#meta) | |
| originData | Raw data | () => [DataType\[\]](#datatype) | |
| totalData | summary data | () => [DataType\[\]](#datatype) | |
| indexesData | multidimensional index data | () => [DataType\[\]](#datatype) | |
| sortParams | sort configuration | () => [SortParams](/docs/api/general/S2DataConfig#sortparams) | |
| spreadsheet | Form example | () => [SpreadSheet](/docs/api/basic-class/spreadsheet) | |
| getFieldMeta | Get field metadata information | (field: string, meta?: [Meta\[\]](/docs/api/general/S2DataConfig#meta) ) => [Meta](/docs/api/general/S2DataConfig#meta) | |
| getFieldName | get field name | `() => string` | |
| getFieldFormatter | Get the field formatting function | `() => (v: string) => unknown` | |
| getFieldDescription | Get field description | `() => string` | |
| setDataCfg | Set data configuration | `<T extends boolean = false>(dataCfg: T extends true ?` [`S2DataConfig`](/docs/api/general/S2DataConfig) `: Partial<`[`S2DataConfig`](/docs/api/general/S2DataConfig)`>, reset?: T) => void` | The `reset` parameter needs to be used in `@antv/s2-v1.34.0` version |
| getDisplayDataSet | Get the currently displayed dataset | () => [DataType\[\]](#datatype) | |
| getDimensionValues | get dimension value | (filed: string, query?: [DataType](#datatype) ) => string\[] | |
| getCellData | Get a single cell data | (params: [CellDataParams](#celldataparams) ) => [DataType\[\]](#datatype) | |
| getMultiData | Get bulk cell data | (query: [DataType](#datatype) , isTotals?: boolean, isRow?: boolean, drillDownFields?: string\[], includeTotalData:boolean) => [DataType\[\]](#datatype) | |
| moreThanOneValue | Is there more than 1 value | () => [ViewMeta](#viewmeta) | |

### DataType

Expand Down
2 changes: 1 addition & 1 deletion s2-site/docs/api/basic-class/base-data-set.zh.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ s2.dataSet.getFieldName('type')
| getDisplayDataSet | 获取当前显示的数据集 | () => [DataType[]](#datatype) | |
| getDimensionValues | 获取维值 | (filed: string, query?: [DataType](#datatype) ) => string[] | |
| getCellData | 获取单个的单元格数据 | (params: [CellDataParams](#celldataparams)) => [DataType[]](#datatype) | |
| getMultiData | 获取批量的单元格数据 | (query: [DataType](#datatype), isTotals?: boolean, isRow?: boolean, drillDownFields?: string[],includeTotalData:boolean) => [DataType[]](#datatype) | |
| getMultiData | 获取批量的单元格数据 | (query: [DataType](#datatype), isTotals?: boolean, isRow?: boolean, drillDownFields?: string[], includeTotalData:boolean) => [DataType[]](#datatype) | |
| moreThanOneValue | 是否超过 1 个数值 | () => [ViewMeta](#viewmeta) | |

### DataType
Expand Down

0 comments on commit 0a0fa17

Please sign in to comment.