Skip to content

Commit

Permalink
docs: fix typos (#5476)
Browse files Browse the repository at this point in the history
* fix typos

* fix typo

* fix typos

* fix typos
  • Loading branch information
omahs authored Feb 27, 2024
1 parent b86bdcd commit 7539c3e
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion packages/site/docs/apis/data/NodeDisplayModel.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: NodeDisplayModel
order: 5
---

NodeDisplayModel is the the rendering data of Node, which is obtained by [NodeModel](./NodeModel.en.md) through [data mapping](./DataIntro.en.md#mappers). NodeDisplayModel can only be accessed by G6.
NodeDisplayModel is the rendering data of Node, which is obtained by [NodeModel](./NodeModel.en.md) through [data mapping](./DataIntro.en.md#mappers). NodeDisplayModel can only be accessed by G6.

<embed src="../../common/DataID.en.md"></embed>

Expand Down
6 changes: 3 additions & 3 deletions packages/site/docs/apis/plugins/EdgeBundling.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The initial step length.

**Default**`1`

The initial number of division on each edge. It will be multipled by `divRate` in each cycle.
The initial number of division on each edge. It will be multiplied by `divRate` in each cycle.

### divRate

Expand All @@ -63,15 +63,15 @@ The rate of the divisions increasement. Large number means smoother result, but

**Default**`6`

The number of outer interations.
The number of outer iterations.

### iterations

**Type**`number`

**Default**`90`

The initial number of inner interations. It will be multiplied by `iterRate` in each cycle.
The initial number of inner iterations. It will be multiplied by `iterRate` in each cycle.

### iterRate

Expand Down
4 changes: 2 additions & 2 deletions packages/site/examples/interaction/select/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ title: Select
order: 14
---

G6 provides some built-in behaviors for selection, including selecting a single item, selecting multiple items, selecting items by brushing, and selecting items by a lasso. Where behavior `'lasso-select'` for selecting by a lasso is a new feature of V3.6.2, which allows the users select items by drawing a irregular polygon as lasso.
G6 provides some built-in behaviors for selection, including selecting a single item, selecting multiple items, selecting items by brushing, and selecting items by a lasso. Where behavior `'lasso-select'` for selecting by a lasso is a new feature of V3.6.2, which allows the users to select items by drawing an irregular polygon as lasso.

## Usage

- Selecting a single item or selecting multiple items: a built-in behavior `'click-select'` with default configurations allows the end-user to select a single item by clicking. You can configure `multiple: true` for it to allow multiple selection by combining mouse clicking and keydown on keyboard. By default, the combined key is `shift`, and you can switch the `trigger` to one of `'shift'`, `'ctrl'`, `'alt'`, `'control'` as you want. For more detail, please refer to click-select](/en/docs/manual/middle/states/defaultBehavior#click-select);

- Selecting multiple items by brush: a built-in behavior `'brush-select'` with default configurations allows the end-user to select multiple items by combining `shift` keydown and draging start from any empty space on the canvas. The key can be switched to one of `'drag'`, `'shift'`, `'ctrl'`, `'alt'`, `'control'` by configuring `trigger`. Notice that, when you are using `'drag'` for `trigger`, the brush selection will start when the end-user drag the canvas without combining key, which might be conflict with `'drag-canvas'` if you configured. So we suggest to use one key for `trigger` to solve the conflict, For more detail, please refer to [brush-select](/en/docs/manual/middle/states/defaultBehavior#brush-select);
- Selecting multiple items by brush: a built-in behavior `'brush-select'` with default configurations allows the end-user to select multiple items by combining `shift` keydown and dragging start from any empty space on the canvas. The key can be switched to one of `'drag'`, `'shift'`, `'ctrl'`, `'alt'`, `'control'` by configuring `trigger`. Notice that, when you are using `'drag'` for `trigger`, the brush selection will start when the end-user drag the canvas without combining key, which might be conflict with `'drag-canvas'` if you configured. So we suggest to use one key for `trigger` to solve the conflict, For more detail, please refer to [brush-select](/en/docs/manual/middle/states/defaultBehavior#brush-select);

- Selecting multiple items by a lasso: a built-in behavior `'lasso-select` allows end-user to draw a lasso to select items inside it. Similar to `'brush-select'`, there are multiple options for `trigger` for keyboard combination. For more detail, please refer to [lasso-select](/en/docs/manual/middle/states/defaultBehavior#lasso-select).
6 changes: 3 additions & 3 deletions packages/site/examples/interaction/setMode/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ title: Change Mode to Add items
order: 8
---

You can change to different modes with the selector on the left top. Dragging node, adding node, adding edge are enabled in different modes. This mechanism help developers to avoid the conflict of same events in different behaviors.
You can change to different modes with the selector on the left top. Dragging node, adding node, adding edge are enabled in different modes. This mechanism helps developers to avoid the conflict of same events in different behaviors.

## Usage

Change to different modes with the selector on the left top.

- When the 'Default' is selected, the mode is changed to default: The node will move withe the mouse when user drags it; The node will be selected when user clicks it;
- When the 'Default' is selected, the mode is changed to default: The node will move with the mouse when user drags it; The node will be selected when user clicks it;
- When 'Add Node' is selected, the mode is changed to addNode: A new node will be added when user clicks the blank part of the canvas; The node will be selected when user clicks it;
- When 'Add Edge' is selected, the mode is changed to addEdge: An new edge will be added when user clicks two different end nodes.
- When 'Add Edge' is selected, the mode is changed to addEdge: A new edge will be added when user clicks two different end nodes.

0 comments on commit 7539c3e

Please sign in to comment.