Skip to content

Commit ba0e28a

Browse files
committed
docs: update guide docs
1 parent dd9cbc6 commit ba0e28a

File tree

2 files changed

+36
-42
lines changed

2 files changed

+36
-42
lines changed

src/en-US/guide/class-idraw.md

+18-21
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,8 @@ const options = {
1010
height: 400,
1111
devicePixelRatio: 2
1212
};
13-
const config = {
14-
scrollWrapper: {
15-
use: true
16-
}
17-
};
1813

19-
const idraw = new iDraw(dom, options, config);
14+
const idraw = new iDraw(dom, options);
2015
```
2116

2217
| Arugment | Description | Type | Default | Required | Others |
@@ -31,26 +26,28 @@ type Options = {
3126
width: number;
3227
height: number;
3328
devicePixelRatio: number;
34-
disableScroll?: boolean;
35-
disableSelect?: boolean;
36-
disableScale?: boolean;
37-
disableRuler?: boolean;
38-
disableTextEdit?: boolean;
29+
enableScroll?: boolean;
30+
enableSelect?: boolean;
31+
enableScale?: boolean;
32+
enableRuler?: boolean;
33+
enableTextEdit?: boolean;
34+
enableDrag?: boolean;
3935
};
4036
```
4137

4238
### Options Properties
4339

44-
| Property | Description | Type | Default | Required | Others |
45-
| ---------------- | ------------------------------ | --------- | ------- | -------- | ------ |
46-
| width | Drawing board's width | `number` | - | `true` | - |
47-
| height | Drawing board's height | `number` | - | `true` | - |
48-
| devicePixelRatio | Device pixel scale | `number` | `1` | `false` | - |
49-
| disableScroll | Disable canvas scroll | `boolean` | `false` | `false` | - |
50-
| disableSelect | Disable canvas select elements | `boolean` | `false` | `false` | - |
51-
| disableScale | Disable scale | `boolean` | `false` | `false` | - |
52-
| disableRuler | Disable ruler | `boolean` | `false` | `false` | - |
53-
| disableTextEdit | Disable editing text | `boolean` | `false` | `false` | - |
40+
| Property | Description | Type | Default | Required | Others |
41+
| ---------------- | ------------------------------------------------------------------- | --------- | ------- | -------- | ------ |
42+
| width | Drawing board's width | `number` | - | `true` | - |
43+
| height | Drawing board's height | `number` | - | `true` | - |
44+
| devicePixelRatio | Device pixel scale | `number` | `1` | `false` | - |
45+
| enableScroll | Enable canvas scroll | `boolean` | `true` | `false` | - |
46+
| enableSelect | Enable canvas select elements, Mutually exclusive with `enableDrag` | `boolean` | `true` | `false` | - |
47+
| enableScale | Enable scale | `boolean` | `true` | `false` | - |
48+
| enableRuler | Enable ruler | `boolean` | `true` | `false` | - |
49+
| enableTextEdit | Enable editing text | `boolean` | `true` | `false` | - |
50+
| enableDrag | Enable drag feature, Mutually exclusive with `enableSelect` | `boolean` | `false` | `false` | - |
5451

5552
### Options Preivew
5653

src/zh-CN/guide/class-idraw.md

+18-21
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,8 @@ const options = {
1010
height: 400,
1111
devicePixelRatio: 2
1212
};
13-
const config = {
14-
scrollWrapper: {
15-
use: true
16-
}
17-
};
1813

19-
const idraw = new iDraw(dom, options, config);
14+
const idraw = new iDraw(dom, options);
2015
```
2116

2217
在使用 `new iDraw(dom, options)` 类时,会接收三个参数。参数信息有下:
@@ -33,26 +28,28 @@ type Options = {
3328
width: number;
3429
height: number;
3530
devicePixelRatio: number;
36-
disableScroll?: boolean;
37-
disableSelect?: boolean;
38-
disableScale?: boolean;
39-
disableRuler?: boolean;
40-
disableTextEdit?: boolean;
31+
enableScroll?: boolean;
32+
enableSelect?: boolean;
33+
enableScale?: boolean;
34+
enableRuler?: boolean;
35+
enableTextEdit?: boolean;
36+
enableDrag?: boolean;
4137
};
4238
```
4339

4440
### Options 属性
4541

46-
| 属性 | 说明 | 类型 | 默认值 | 是否必填 | 备注 |
47-
| ---------------- | ------------ | --------- | ------- | -------- | ---- |
48-
| width | 画板宽度 | `number` | - | `true` | - |
49-
| height | 画板高度 | `number` | - | `true` | - |
50-
| devicePixelRatio | 设备像素比例 | `number` | `1` | `false` | - |
51-
| disableScroll | 禁用滚动 | `boolean` | `false` | `false` | - |
52-
| disableSelect | 禁用选择 | `boolean` | `false` | `false` | - |
53-
| disableScale | 禁用缩放 | `boolean` | `false` | `false` | - |
54-
| disableRuler | 禁用标尺 | `boolean` | `false` | `false` | - |
55-
| disableTextEdit | 禁用文本编辑 | `boolean` | `false` | `false` | - |
42+
| 属性 | 说明 | 类型 | 默认值 | 是否必填 | 备注 |
43+
| ---------------- | ------------------------------------ | --------- | ------- | -------- | ---- |
44+
| width | 画板宽度 | `number` | - | `true` | - |
45+
| height | 画板高度 | `number` | - | `true` | - |
46+
| devicePixelRatio | 设备像素比例 | `number` | `1` | `false` | - |
47+
| enableScroll | 启用视图滚动 | `boolean` | `true` | `false` | - |
48+
| enableSelect | 启用元素选择(和`enableDrag`互斥) | `boolean` | `true` | `false` | - |
49+
| enableScale | 启用视图缩放 | `boolean` | `true` | `false` | - |
50+
| enableRuler | 启用视图标尺 | `boolean` | `true` | `false` | - |
51+
| enableTextEdit | 启用文本编辑 | `boolean` | `true` | `false` | - |
52+
| enableDrag | 启用视图拖拽(和`enableSelect`互斥) | `boolean` | `false` | `false` | - |
5653

5754
### Options 效果预览
5855

0 commit comments

Comments
 (0)