Skip to content

Commit 322acf4

Browse files
pddpdneoddish
authored andcommitted
docs(site): adjust data docs to fit v3
1 parent 657dbcf commit 322acf4

26 files changed

+117
-3129
lines changed

.prettierignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,6 @@ LICENSE
1717
node_modules/
1818
public/
1919

20-
# don't prettier constance js
21-
packages/data-wizard/src/random/cn-address-dict.ts
22-
2320
# umi
2421
**/*.md
2522
**/*.svg

packages/ava/src/advisor/advise-pipeline/data-to-advices.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ function applySmartColor(
177177
* recommending charts given data and dataProps, based on CKB and RuleBase
178178
*
179179
* @param data input data [ {a: xxx, b: xxx}, ... ]
180-
* @param dataProps data props derived from data-wizard or customized by users
180+
* @param dataProps data props derived from data or customized by users
181181
* @param chartWIKI ckb
182182
* @param ruleBase rule base
183183
* @param smartColor switch smart color on/off, optional props, default is off

packages/ava/src/advisor/advise-pipeline/spec-mapping.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ function heatmap(data: Data, dataProps: BasicDataPropertyForAdvice[]): Advice['s
492492
*
493493
* @param chartType chart type
494494
* @param data input data [ { col1: ..., col2: ... } ]
495-
* @param dataProps data property for advisor derived by data-wizard
495+
* @param dataProps data property for advisor derived by data
496496
* @param chartKnowledge chart knowledge of a singble chart
497497
* @returns spec or null
498498
*/

playground/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@
4343
"@antv/auto-chart": "^2.0.3",
4444
"@antv/chart-advisor": "^2.0.3",
4545
"@antv/ckb": "^2.0.3",
46-
"@antv/data-wizard": "^2.0.3",
4746
"@antv/g2": "5.0.0-rc.2",
4847
"@antv/g2plot": "^2.0.9",
4948
"@antv/g6": "^4.3.11",

site/docs/api/data/data-frame.en.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ order: 0
55

66
<embed src='@/docs/common/style.md'></embed>
77

8-
`DataFrame` is the specified 2D data structure in DW. You can get or slice data by it. The information includes the field's characteristics (field name, data type, statistics, etc.) and properties (continuity, discreteness, etc.), as well as field-to-field relationships (correlation, periodicity, etc.).
8+
`DataFrame` is the specified 2D data structure in data. You can get or slice data by it. The information includes the field's characteristics (field name, data type, statistics, etc.) and properties (continuity, discreteness, etc.), as well as field-to-field relationships (correlation, periodicity, etc.).
99

1010
## new DataFrame
1111

@@ -47,7 +47,7 @@ Used to configure indexes, columns, and missing values.
4747

4848

4949
```ts
50-
import { DataFrame } from '@antv/data-wizard';
50+
import { DataFrame } from '@antv/ava';
5151

5252
/* Basic usage */
5353
const data = [
@@ -170,7 +170,7 @@ Get the DataFrame data row and column dimensions.
170170

171171

172172
```ts
173-
import { DataFrame } from '@antv/data-wizard';
173+
import { DataFrame } from '@antv/ava';
174174

175175
const df = new DataFrame([
176176
{ a: 1, b: 4, c: 7 }
@@ -211,7 +211,7 @@ Type `(string | number) | (string | number)[] | string`
211211

212212

213213
```ts
214-
import { DataFrame } from '@antv/data-wizard';
214+
import { DataFrame } from '@antv/ava';
215215

216216
/* Get data by indexes value */
217217
const df = new DataFrame([
@@ -350,7 +350,7 @@ Type `number | number[] | string`
350350
***<font size=4>Usage</font>***
351351

352352
```ts
353-
import { DataFrame } from '@antv/data-wizard';
353+
import { DataFrame } from '@antv/ava';
354354

355355
/* Get data by row index */
356356
const df = new DataFrame([
@@ -392,7 +392,7 @@ Type `string | number`
392392

393393

394394
```ts
395-
import { DataFrame } from '@antv/data-wizard';
395+
import { DataFrame } from '@antv/ava';
396396

397397
const df = new DataFrame([
398398
{ a: 1, b: 4, c: 7 }
@@ -422,7 +422,7 @@ Get statistical information.
422422

423423

424424
```ts
425-
import { DataFrame } from '@antv/data-wizard';
425+
import { DataFrame } from '@antv/ava';
426426

427427
const df = new DataFrame([
428428
{ a: 1, b: 4, c: 7 },

site/docs/api/data/data-frame.zh.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ order: 0
66
<embed src='@/docs/common/style.md'></embed>
77

88

9-
DW 中的二维数据结构,支持读取不同类型的一维和二维源数据,将其转换为 `DataFrame` 数据基本流转单元来处理数据。使用 `DataFrame`,你可以从一个数据集样本中获取和切割数据,也可以提取出各个字段的信息。这些信息包括字段的特征(字段名称、数据类型、统计信息等),性质(连续性、离散性等),以及多字段间的字段间关系(相关性、周期性等)。
9+
data 中的二维数据结构,支持读取不同类型的一维和二维源数据,将其转换为 `DataFrame` 数据基本流转单元来处理数据。使用 `DataFrame`,你可以从一个数据集样本中获取和切割数据,也可以提取出各个字段的信息。这些信息包括字段的特征(字段名称、数据类型、统计信息等),性质(连续性、离散性等),以及多字段间的字段间关系(相关性、周期性等)。
1010

1111
## new DataFrame
1212

@@ -48,7 +48,7 @@ DW 中的二维数据结构,支持读取不同类型的一维和二维源数
4848

4949

5050
```ts
51-
import { DataFrame } from '@antv/data-wizard';
51+
import { DataFrame } from '@antv/ava';
5252

5353
/* Basic usage */
5454
const data = [
@@ -171,7 +171,7 @@ DataFrame
171171

172172

173173
```ts
174-
import { DataFrame } from '@antv/data-wizard';
174+
import { DataFrame } from '@antv/ava';
175175

176176
const df = new DataFrame([
177177
{ a: 1, b: 4, c: 7 },
@@ -211,7 +211,7 @@ df.shape;
211211

212212

213213
```ts
214-
import { DataFrame } from '@antv/data-wizard';
214+
import { DataFrame } from '@antv/ava';
215215

216216
/* 使用 indexes值 获取数据 */
217217
const df = new DataFrame([
@@ -351,7 +351,7 @@ DataFrame
351351

352352

353353
```ts
354-
import { DataFrame } from '@antv/data-wizard';
354+
import { DataFrame } from '@antv/ava';
355355

356356
/* 行列索引获取数据 */
357357
const df = new DataFrame([
@@ -393,7 +393,7 @@ DataFrame
393393

394394

395395
```ts
396-
import { DataFrame } from '@antv/data-wizard';
396+
import { DataFrame } from '@antv/ava';
397397

398398
const df = new DataFrame([
399399
{ a: 1, b: 4, c: 7 },
@@ -424,7 +424,7 @@ Series
424424

425425

426426
```ts
427-
import { DataFrame } from '@antv/data-wizard';
427+
import { DataFrame } from '@antv/ava';
428428

429429
const df = new DataFrame([
430430
{ a: 1, b: 4, c: 7 },

0 commit comments

Comments
 (0)