diff --git a/packages/g6/package.json b/packages/g6/package.json index bc9d09e337..6c7254f2f0 100644 --- a/packages/g6/package.json +++ b/packages/g6/package.json @@ -39,7 +39,7 @@ "ci": "run-s lint build", "clean": "rimraf es lib", "coverage": "jest --coverage", - "clear:doc": "rimraf ../site/docs/apis", + "clear:doc": "rimraf ../site/docs/_apis", "doc": "npm run clear:doc && typedoc", "lint": "eslint ./src --quiet && prettier ./src --check", "lint-staged:js": "eslint --ext .js,.jsx,.ts,.tsx", diff --git a/packages/g6/typedoc.config.js b/packages/g6/typedoc.config.js index 25ceade241..7e2752a6f8 100644 --- a/packages/g6/typedoc.config.js +++ b/packages/g6/typedoc.config.js @@ -1,12 +1,11 @@ const path = require('path'); -const outputDir = path.resolve(__dirname, '../site/docs/apis'); +const outputDir = path.resolve(__dirname, '../site/docs/_apis'); console.log('outputDir', outputDir); module.exports = { entryPoints: [ /** graph */ 'src/api-doc/graph.ts', - /** plugins */ 'src/api-doc/plugins.ts', /** behaviors */ diff --git a/packages/site/.dumirc.ts b/packages/site/.dumirc.ts index 480ec31163..7809f9fdc0 100644 --- a/packages/site/.dumirc.ts +++ b/packages/site/.dumirc.ts @@ -59,7 +59,7 @@ export default defineConfig({ themeSwitcher: 'g2', versions: { // 历史版本以及切换下拉菜单 - [version]: 'https://g6.antv.antgroup.com', + [version]: 'https://g6-next.antv.antgroup.com', '4.x': 'https://g6.antv.antgroup.com', '3.2.x': 'https://g6-v3-2.antv.vision', }, diff --git a/packages/site/.gitignore b/packages/site/.gitignore index 25c52d1663..b5564dd557 100644 --- a/packages/site/.gitignore +++ b/packages/site/.gitignore @@ -8,3 +8,7 @@ .dumi/tmp .dumi/tmp-production .DS_Store + +## api doc +docs/_apis +.translate-info.txt \ No newline at end of file diff --git a/packages/site/docs/apis/README.md b/packages/site/docs/apis/README.en.md similarity index 82% rename from packages/site/docs/apis/README.md rename to packages/site/docs/apis/README.en.md index bc9b4ad012..45836d066c 100644 --- a/packages/site/docs/apis/README.md +++ b/packages/site/docs/apis/README.en.md @@ -1,4 +1,4 @@ -Overview / [Modules](modules.md) +Overview / [Modules](modules.en.md) ```jsx import { Graph, Util } from '@antv/g6'; @@ -39,13 +39,13 @@ In the above code snippet, we may want to know more about what G6 has to offer, #### What types, methods and classes are exported in the '@antv/g6' package? -- [Graph](./classes/graph.Graph.md) -- [Util](./module/utils.md) +- [Graph](./classes/graph.Graph.en.md) +- [Util](./module/utils.en.md) #### What is Specification which in `new Graph(Specification)`? -- [Specification](./interfaces/types.Specification.md) +- [Specification](./interfaces/types.Specification.en.md) #### What are the detailed parameters of the plugins ? -- [Plugins](./modules/plugins.md) +- [Plugins](./modules/plugins.en.md) diff --git a/packages/site/docs/apis/README.zh.md b/packages/site/docs/apis/README.zh.md new file mode 100644 index 0000000000..cf12743012 --- /dev/null +++ b/packages/site/docs/apis/README.zh.md @@ -0,0 +1,51 @@ +概述 / [模块](modules.zh.md) + + ````jsx + 从 '@antv/g6' 导入 { Graph, Util }; + const data = Util.mock(6).circle(); + + 常量图 = 新图({ + 容器:'容器', + 宽度:500, + 高度:500, + 数据, + 布局: { + 类型:'网格', + }, + 插件:[ + { + key: '小地图', + 类型:'小地图', + 大小:[300, 200], + 模式:“委托”, + 委托样式:{ + 填充:'红色', + }, + 类名: 'g6-minimap-2', + viewportClassName: 'g6-minimap-viewport-2', + }, + ], + }); + + const 节点 = graph.getAllNodesData(); + const 节点 = graph.getAllNodesData(); + + graph.on('节点:点击', (e) => {}); + ```` + + # 介绍 + + 在上面的代码片段中,我们可能想更多地了解 G6 所提供的功能,在这种情况下,我们将需要 G6 API 文档 + + #### “@antv/g6”包中导出了哪些类型、方法和类? + + - [图](./classes/graph.Graph.zh.md) + - [Util](./module/utils.zh.md) + + #### `new Graph(Specification)`中的Specification是什么? + + - [规范](./interfaces/types.Specification.zh.md) + + #### 插件的详细参数是什么? + + - [插件](./modules/plugins.zh.md) \ No newline at end of file diff --git a/packages/site/docs/apis/classes/graph-Graph.md b/packages/site/docs/apis/classes/graph-Graph.en.md similarity index 53% rename from packages/site/docs/apis/classes/graph-Graph.md rename to packages/site/docs/apis/classes/graph-Graph.en.md index 090a584f0f..239e25e2a3 100644 --- a/packages/site/docs/apis/classes/graph-Graph.md +++ b/packages/site/docs/apis/classes/graph-Graph.en.md @@ -1,8 +1,8 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [graph](../modules/graph.md) / Graph +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [graph](../modules/graph.en.md) / Graph # Class: Graph -[graph](../modules/graph.md).Graph +[graph](../modules/graph.en.md).Graph ## Type parameters @@ -19,13 +19,13 @@ ## Implements -- [`IGraph`](../interfaces/types-IGraph.md)<`B`, `T`\> +- [`IGraph`](../interfaces/types-IGraph.en.md)<`B`, `T`\> ## Combo ### addCombo -▸ **addCombo**(`model`, `childrenIds`): [`ComboModel`](../modules/types.md#combomodel) +▸ **addCombo**(`model`, `childrenIds`): [`ComboModel`](../modules/types.en.md#combomodel) Add a new combo to the graph, and update the structure of the existed child in childrenIds to be the children of the new combo. Different from addData with combo type, this API update the succeeds' combo tree strucutres in the same time. @@ -34,22 +34,22 @@ Different from addData with combo type, this API update the succeeds' combo tree | Name | Type | Description | | :------ | :------ | :------ | -| `model` | [`ComboUserModel`](../modules/types.md#combousermodel) | combo user data | +| `model` | [`ComboUserModel`](../modules/types.en.md#combousermodel) | combo user data | | `childrenIds` | `ID`[] | - | #### Returns -[`ComboModel`](../modules/types.md#combomodel) +[`ComboModel`](../modules/types.en.md#combomodel) whether success #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[addCombo](../interfaces/types-IGraph.md#addcombo) +[IGraph](../interfaces/types-IGraph.en.md).[addCombo](../interfaces/types-IGraph.en.md#addcombo) #### Defined in -[runtime/graph.ts:1516](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1516) +[runtime/graph.ts:1549](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1549) ___ @@ -71,11 +71,11 @@ Collapse a combo. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[collapseCombo](../interfaces/types-IGraph.md#collapsecombo) +[IGraph](../interfaces/types-IGraph.en.md).[collapseCombo](../interfaces/types-IGraph.en.md#collapsecombo) #### Defined in -[runtime/graph.ts:1561](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1561) +[runtime/graph.ts:1594](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1594) ___ @@ -97,17 +97,17 @@ Expand a combo. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[expandCombo](../interfaces/types-IGraph.md#expandcombo) +[IGraph](../interfaces/types-IGraph.en.md).[expandCombo](../interfaces/types-IGraph.en.md#expandcombo) #### Defined in -[runtime/graph.ts:1581](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1581) +[runtime/graph.ts:1614](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1614) ___ ### moveCombo -▸ **moveCombo**(`ids`, `dx`, `dy`, `upsertAncestors?`, `callback?`): [`ComboModel`](../modules/types.md#combomodel)[] +▸ **moveCombo**(`ids`, `dx`, `dy`, `upsertAncestors?`, `callback?`): [`ComboModel`](../modules/types.en.md#combomodel)[] Move one or more combos a distance (dx, dy) relatively, do not update other styles which leads to better performance than updating positions by updateData. @@ -121,19 +121,19 @@ In fact, it changes the succeed nodes positions to affect the combo's position, | `dx` | `number` | | `dy` | `number` | | `upsertAncestors?` | `boolean` | -| `callback?` | (`model`: [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel), `canceled?`: `boolean`) => `void` | +| `callback?` | (`model`: [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel), `canceled?`: `boolean`) => `void` | #### Returns -[`ComboModel`](../modules/types.md#combomodel)[] +[`ComboModel`](../modules/types.en.md#combomodel)[] #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[moveCombo](../interfaces/types-IGraph.md#movecombo) +[IGraph](../interfaces/types-IGraph.en.md).[moveCombo](../interfaces/types-IGraph.en.md#movecombo) #### Defined in -[runtime/graph.ts:1604](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1604) +[runtime/graph.ts:1637](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1637) ## Constructors @@ -152,7 +152,7 @@ In fact, it changes the succeed nodes positions to affect the combo's position, | Name | Type | | :------ | :------ | -| `spec` | [`Specification`](../interfaces/types-Specification.md)<`B`, `T`\> | +| `spec` | [`Specification`](../interfaces/types-Specification.en.md)<`B`, `T`\> | #### Overrides @@ -160,13 +160,13 @@ EventEmitter.constructor #### Defined in -[runtime/graph.ts:106](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L106) +[runtime/graph.ts:106](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L106) ## Data ### addData -▸ **addData**(`itemType`, `models`): [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +▸ **addData**(`itemType`, `models`): [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] Add one or more node/edge/combo data to the graph. @@ -175,21 +175,21 @@ Add one or more node/edge/combo data to the graph. | Name | Type | Description | | :------ | :------ | :------ | | `itemType` | `ITEM_TYPE` | item type | -| `models` | [`EdgeUserModel`](../modules/types.md#edgeusermodel) \| [`NodeUserModel`](../modules/types.md#nodeusermodel) \| [`ComboUserModel`](../modules/types.md#combousermodel) \| [`NodeUserModel`](../modules/types.md#nodeusermodel)[] \| [`EdgeUserModel`](../modules/types.md#edgeusermodel)[] \| [`ComboUserModel`](../modules/types.md#combousermodel)[] | - | +| `models` | [`EdgeUserModel`](../modules/types.en.md#edgeusermodel) \| [`NodeUserModel`](../modules/types.en.md#nodeusermodel) \| [`ComboUserModel`](../modules/types.en.md#combousermodel) \| [`NodeUserModel`](../modules/types.en.md#nodeusermodel)[] \| [`EdgeUserModel`](../modules/types.en.md#edgeusermodel)[] \| [`ComboUserModel`](../modules/types.en.md#combousermodel)[] | - | #### Returns -[`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +[`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] whether success #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[addData](../interfaces/types-IGraph.md#adddata) +[IGraph](../interfaces/types-IGraph.en.md).[addData](../interfaces/types-IGraph.en.md#adddata) #### Defined in -[runtime/graph.ts:942](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L942) +[runtime/graph.ts:975](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L975) ___ @@ -212,83 +212,83 @@ Change graph data. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[changeData](../interfaces/types-IGraph.md#changedata) +[IGraph](../interfaces/types-IGraph.en.md).[changeData](../interfaces/types-IGraph.en.md#changedata) #### Defined in -[runtime/graph.ts:436](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L436) +[runtime/graph.ts:456](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L456) ___ ### getAllCombosData -▸ **getAllCombosData**(): [`ComboModel`](../modules/types.md#combomodel)[] +▸ **getAllCombosData**(): [`ComboModel`](../modules/types.en.md#combomodel)[] Get all the combos' inner data #### Returns -[`ComboModel`](../modules/types.md#combomodel)[] +[`ComboModel`](../modules/types.en.md#combomodel)[] all combos' inner data on the graph #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getAllCombosData](../interfaces/types-IGraph.md#getallcombosdata) +[IGraph](../interfaces/types-IGraph.en.md).[getAllCombosData](../interfaces/types-IGraph.en.md#getallcombosdata) #### Defined in -[runtime/graph.ts:866](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L866) +[runtime/graph.ts:886](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L886) ___ ### getAllEdgesData -▸ **getAllEdgesData**(): [`EdgeModel`](../modules/types.md#edgemodel)[] +▸ **getAllEdgesData**(): [`EdgeModel`](../modules/types.en.md#edgemodel)[] Get all the edges' inner data #### Returns -[`EdgeModel`](../modules/types.md#edgemodel)[] +[`EdgeModel`](../modules/types.en.md#edgemodel)[] all edges' inner data on the graph #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getAllEdgesData](../interfaces/types-IGraph.md#getalledgesdata) +[IGraph](../interfaces/types-IGraph.en.md).[getAllEdgesData](../interfaces/types-IGraph.en.md#getalledgesdata) #### Defined in -[runtime/graph.ts:858](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L858) +[runtime/graph.ts:878](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L878) ___ ### getAllNodesData -▸ **getAllNodesData**(): [`NodeModel`](../modules/types.md#nodemodel)[] +▸ **getAllNodesData**(): [`NodeModel`](../modules/types.en.md#nodemodel)[] Get all the nodes' inner data #### Returns -[`NodeModel`](../modules/types.md#nodemodel)[] +[`NodeModel`](../modules/types.en.md#nodemodel)[] all nodes' inner data on the graph #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getAllNodesData](../interfaces/types-IGraph.md#getallnodesdata) +[IGraph](../interfaces/types-IGraph.en.md).[getAllNodesData](../interfaces/types-IGraph.en.md#getallnodesdata) #### Defined in -[runtime/graph.ts:850](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L850) +[runtime/graph.ts:870](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L870) ___ ### getComboChildrenData -▸ **getComboChildrenData**(`comboId`): ([`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel))[] +▸ **getComboChildrenData**(`comboId`): ([`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel))[] Get the children's data of a combo. @@ -300,23 +300,23 @@ Get the children's data of a combo. #### Returns -([`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel))[] +([`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel))[] children's data array #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getComboChildrenData](../interfaces/types-IGraph.md#getcombochildrendata) +[IGraph](../interfaces/types-IGraph.en.md).[getComboChildrenData](../interfaces/types-IGraph.en.md#getcombochildrendata) #### Defined in -[runtime/graph.ts:899](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L899) +[runtime/graph.ts:919](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L919) ___ ### getComboData -▸ **getComboData**(`condition`): [`ComboModel`](../modules/types.md#combomodel) +▸ **getComboData**(`condition`): [`ComboModel`](../modules/types.en.md#combomodel) Find an combo's inner data according to id or function. @@ -328,23 +328,23 @@ Find an combo's inner data according to id or function. #### Returns -[`ComboModel`](../modules/types.md#combomodel) +[`ComboModel`](../modules/types.en.md#combomodel) result combo's inner data #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getComboData](../interfaces/types-IGraph.md#getcombodata) +[IGraph](../interfaces/types-IGraph.en.md).[getComboData](../interfaces/types-IGraph.en.md#getcombodata) #### Defined in -[runtime/graph.ts:840](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L840) +[runtime/graph.ts:860](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L860) ___ ### getEdgeData -▸ **getEdgeData**(`condition`): [`EdgeModel`](../modules/types.md#edgemodel) +▸ **getEdgeData**(`condition`): [`EdgeModel`](../modules/types.en.md#edgemodel) Find an edge's inner data according to id or function. @@ -356,23 +356,49 @@ Find an edge's inner data according to id or function. #### Returns -[`EdgeModel`](../modules/types.md#edgemodel) +[`EdgeModel`](../modules/types.en.md#edgemodel) result edge's inner data #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getEdgeData](../interfaces/types-IGraph.md#getedgedata) +[IGraph](../interfaces/types-IGraph.en.md).[getEdgeData](../interfaces/types-IGraph.en.md#getedgedata) #### Defined in -[runtime/graph.ts:827](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L827) +[runtime/graph.ts:847](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L847) + +___ + +### getNearEdgesForNode + +▸ **getNearEdgesForNode**(`nodeId`): [`EdgeModel`](../modules/types.en.md#edgemodel)[] + +Retrieve the nearby edges for a given node using quadtree collision detection. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `nodeId` | `ID` | node id | + +#### Returns + +[`EdgeModel`](../modules/types.en.md#edgemodel)[] + +#### Implementation of + +[IGraph](../interfaces/types-IGraph.en.md).[getNearEdgesForNode](../interfaces/types-IGraph.en.md#getnearedgesfornode) + +#### Defined in + +[runtime/graph.ts:940](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L940) ___ ### getNeighborNodesData -▸ **getNeighborNodesData**(`nodeId`, `direction?`): [`NodeModel`](../modules/types.md#nodemodel)[] +▸ **getNeighborNodesData**(`nodeId`, `direction?`): [`NodeModel`](../modules/types.en.md#nodemodel)[] Get one-hop node ids from a start node. @@ -385,23 +411,23 @@ Get one-hop node ids from a start node. #### Returns -[`NodeModel`](../modules/types.md#nodemodel)[] +[`NodeModel`](../modules/types.en.md#nodemodel)[] one-hop nodes' data array #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getNeighborNodesData](../interfaces/types-IGraph.md#getneighbornodesdata) +[IGraph](../interfaces/types-IGraph.en.md).[getNeighborNodesData](../interfaces/types-IGraph.en.md#getneighbornodesdata) #### Defined in -[runtime/graph.ts:887](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L887) +[runtime/graph.ts:907](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L907) ___ ### getNodeData -▸ **getNodeData**(`condition`): [`NodeModel`](../modules/types.md#nodemodel) +▸ **getNodeData**(`condition`): [`NodeModel`](../modules/types.en.md#nodemodel) Find a node's inner data according to id or function. @@ -413,23 +439,23 @@ Find a node's inner data according to id or function. #### Returns -[`NodeModel`](../modules/types.md#nodemodel) +[`NodeModel`](../modules/types.en.md#nodemodel) result node's inner data #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getNodeData](../interfaces/types-IGraph.md#getnodedata) +[IGraph](../interfaces/types-IGraph.en.md).[getNodeData](../interfaces/types-IGraph.en.md#getnodedata) #### Defined in -[runtime/graph.ts:816](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L816) +[runtime/graph.ts:836](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L836) ___ ### getRelatedEdgesData -▸ **getRelatedEdgesData**(`nodeId`, `direction?`): [`EdgeModel`](../modules/types.md#edgemodel)[] +▸ **getRelatedEdgesData**(`nodeId`, `direction?`): [`EdgeModel`](../modules/types.en.md#edgemodel)[] Get one-hop edge ids from a start node. @@ -442,17 +468,17 @@ Get one-hop edge ids from a start node. #### Returns -[`EdgeModel`](../modules/types.md#edgemodel)[] +[`EdgeModel`](../modules/types.en.md#edgemodel)[] one-hop edges' data array #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getRelatedEdgesData](../interfaces/types-IGraph.md#getrelatededgesdata) +[IGraph](../interfaces/types-IGraph.en.md).[getRelatedEdgesData](../interfaces/types-IGraph.en.md#getrelatededgesdata) #### Defined in -[runtime/graph.ts:875](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L875) +[runtime/graph.ts:895](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L895) ___ @@ -475,11 +501,11 @@ If there is old data, diffs and changes it. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[read](../interfaces/types-IGraph.md#read) +[IGraph](../interfaces/types-IGraph.en.md).[read](../interfaces/types-IGraph.en.md#read) #### Defined in -[runtime/graph.ts:405](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L405) +[runtime/graph.ts:405](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L405) ___ @@ -504,17 +530,17 @@ whether success #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[removeData](../interfaces/types-IGraph.md#removedata) +[IGraph](../interfaces/types-IGraph.en.md).[removeData](../interfaces/types-IGraph.en.md#removedata) #### Defined in -[runtime/graph.ts:999](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L999) +[runtime/graph.ts:1032](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1032) ___ ### updateComboPosition -▸ **updateComboPosition**(`models`, `upsertAncestors?`, `disableAnimate?`, `callback?`, `stack?`): [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +▸ **updateComboPosition**(`models`, `upsertAncestors?`, `disableAnimate?`, `callback?`, `stack?`): [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] Update one or more combos' positions, do not update other styles which leads to better performance than updating positions by updateData. @@ -524,29 +550,29 @@ In fact, it changes the succeed nodes positions to affect the combo's position, | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `models` | `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel)\>[]\> | `undefined` | new configurations with x and y for every combo, which has id field to indicate the specific item | +| `models` | `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel)\>[]\> | `undefined` | new configurations with x and y for every combo, which has id field to indicate the specific item | | `upsertAncestors?` | `boolean` | `undefined` | - | | `disableAnimate` | `boolean` | `false` | - | -| `callback?` | (`model`: [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel)) => `void` | `undefined` | - | +| `callback?` | (`model`: [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel)) => `void` | `undefined` | - | | `stack?` | `boolean` | `undefined` | - | #### Returns -[`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +[`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[updateComboPosition](../interfaces/types-IGraph.md#updatecomboposition) +[IGraph](../interfaces/types-IGraph.en.md).[updateComboPosition](../interfaces/types-IGraph.en.md#updatecomboposition) #### Defined in -[runtime/graph.ts:1178](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1178) +[runtime/graph.ts:1211](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1211) ___ ### updateData -▸ **updateData**(`itemType`, `models`): [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +▸ **updateData**(`itemType`, `models`): [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] Update one or more node/edge/combo data on the graph. @@ -555,25 +581,25 @@ Update one or more node/edge/combo data on the graph. | Name | Type | Description | | :------ | :------ | :------ | | `itemType` | `ITEM_TYPE` | 'node' \| 'edge' \| 'combo' | -| `models` | `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\> \| `Partial`<[`EdgeUserModel`](../modules/types.md#edgeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\>[] \| `Partial`<[`EdgeUserModel`](../modules/types.md#edgeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel)\>[]\> | new configurations for every node/edge/combo, which has id field to indicate the specific item | +| `models` | `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\> \| `Partial`<[`EdgeUserModel`](../modules/types.en.md#edgeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\>[] \| `Partial`<[`EdgeUserModel`](../modules/types.en.md#edgeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel)\>[]\> | new configurations for every node/edge/combo, which has id field to indicate the specific item | #### Returns -[`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +[`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[updateData](../interfaces/types-IGraph.md#updatedata) +[IGraph](../interfaces/types-IGraph.en.md).[updateData](../interfaces/types-IGraph.en.md#updatedata) #### Defined in -[runtime/graph.ts:1089](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1089) +[runtime/graph.ts:1122](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1122) ___ ### updateNodePosition -▸ **updateNodePosition**(`models`, `upsertAncestors?`, `disableAnimate?`, `callback?`, `stack?`): [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +▸ **updateNodePosition**(`models`, `upsertAncestors?`, `disableAnimate?`, `callback?`, `stack?`): [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] Update one or more nodes' positions, do not update other styles which leads to better performance than updating positions by updateData. @@ -582,23 +608,23 @@ do not update other styles which leads to better performance than updating posit | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `models` | `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel)\>[]\> | `undefined` | new configurations with x and y for every node, which has id field to indicate the specific item | +| `models` | `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel)\>[]\> | `undefined` | new configurations with x and y for every node, which has id field to indicate the specific item | | `upsertAncestors?` | `boolean` | `undefined` | - | | `disableAnimate` | `boolean` | `false` | - | -| `callback?` | (`model`: [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel), `canceled?`: `boolean`) => `void` | `undefined` | - | +| `callback?` | (`model`: [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel), `canceled?`: `boolean`) => `void` | `undefined` | - | | `stack?` | `boolean` | `undefined` | - | #### Returns -[`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +[`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[updateNodePosition](../interfaces/types-IGraph.md#updatenodeposition) +[IGraph](../interfaces/types-IGraph.en.md).[updateNodePosition](../interfaces/types-IGraph.en.md#updatenodeposition) #### Defined in -[runtime/graph.ts:1147](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1147) +[runtime/graph.ts:1180](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1180) ## Graph Instance @@ -620,11 +646,11 @@ Destroy the graph instance and remove the related canvases. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[destroy](../interfaces/types-IGraph.md#destroy) +[IGraph](../interfaces/types-IGraph.en.md).[destroy](../interfaces/types-IGraph.en.md#destroy) #### Defined in -[runtime/graph.ts:2139](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2139) +[runtime/graph.ts:2176](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2176) ## Interaction @@ -647,11 +673,11 @@ Add behavior(s) to mode(s). #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[addBehaviors](../interfaces/types-IGraph.md#addbehaviors) +[IGraph](../interfaces/types-IGraph.en.md).[addBehaviors](../interfaces/types-IGraph.en.md#addbehaviors) #### Defined in -[runtime/graph.ts:1729](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1729) +[runtime/graph.ts:1766](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1766) ___ @@ -681,11 +707,11 @@ upserted shape or group #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[drawTransient](../interfaces/types-IGraph.md#drawtransient) +[IGraph](../interfaces/types-IGraph.en.md).[drawTransient](../interfaces/types-IGraph.en.md#drawtransient) #### Defined in -[runtime/graph.ts:1926](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1926) +[runtime/graph.ts:1963](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1963) ___ @@ -708,11 +734,11 @@ Remove behavior(s) from mode(s). #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[removeBehaviors](../interfaces/types-IGraph.md#removebehaviors) +[IGraph](../interfaces/types-IGraph.en.md).[removeBehaviors](../interfaces/types-IGraph.en.md#removebehaviors) #### Defined in -[runtime/graph.ts:1755](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1755) +[runtime/graph.ts:1792](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1792) ___ @@ -734,11 +760,11 @@ Switch mode. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[setMode](../interfaces/types-IGraph.md#setmode) +[IGraph](../interfaces/types-IGraph.en.md).[setMode](../interfaces/types-IGraph.en.md#setmode) #### Defined in -[runtime/graph.ts:1718](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1718) +[runtime/graph.ts:1755](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1755) ___ @@ -761,11 +787,11 @@ Update a behavior on a mode. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[updateBehavior](../interfaces/types-IGraph.md#updatebehavior) +[IGraph](../interfaces/types-IGraph.en.md).[updateBehavior](../interfaces/types-IGraph.en.md#updatebehavior) #### Defined in -[runtime/graph.ts:1782](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1782) +[runtime/graph.ts:1819](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1819) ___ @@ -789,11 +815,11 @@ Update a plugin of the graph. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[updatePlugin](../interfaces/types-IGraph.md#updateplugin) +[IGraph](../interfaces/types-IGraph.en.md).[updatePlugin](../interfaces/types-IGraph.en.md#updateplugin) #### Defined in -[runtime/graph.ts:1876](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1876) +[runtime/graph.ts:1913](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1913) ## Item @@ -815,11 +841,11 @@ Make the item(s) to the back. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[backItem](../interfaces/types-IGraph.md#backitem) +[IGraph](../interfaces/types-IGraph.en.md).[backItem](../interfaces/types-IGraph.en.md#backitem) #### Defined in -[runtime/graph.ts:1367](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1367) +[runtime/graph.ts:1400](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1400) ___ @@ -842,11 +868,11 @@ Clear all the states for item(s). #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[clearItemState](../interfaces/types-IGraph.md#clearitemstate) +[IGraph](../interfaces/types-IGraph.en.md).[clearItemState](../interfaces/types-IGraph.en.md#clearitemstate) #### Defined in -[runtime/graph.ts:1460](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1460) +[runtime/graph.ts:1493](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1493) ___ @@ -863,7 +889,7 @@ Find items which has the state. | `itemType` | `ITEM_TYPE` | `undefined` | item type | | `state` | `string` | `undefined` | state name | | `value` | `string` \| `boolean` | `true` | - | -| `additionalFilter?` | (`item`: [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel)) => `boolean` | `undefined` | additional filter function | +| `additionalFilter?` | (`item`: [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel)) => `boolean` | `undefined` | additional filter function | #### Returns @@ -873,11 +899,11 @@ items that is the type and has the state #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[findIdByState](../interfaces/types-IGraph.md#findidbystate) +[IGraph](../interfaces/types-IGraph.en.md).[findIdByState](../interfaces/types-IGraph.en.md#findidbystate) #### Defined in -[runtime/graph.ts:920](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L920) +[runtime/graph.ts:953](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L953) ___ @@ -899,11 +925,11 @@ Make the item(s) to the front. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[frontItem](../interfaces/types-IGraph.md#frontitem) +[IGraph](../interfaces/types-IGraph.en.md).[frontItem](../interfaces/types-IGraph.en.md#frontitem) #### Defined in -[runtime/graph.ts:1348](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1348) +[runtime/graph.ts:1381](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1381) ___ @@ -927,11 +953,11 @@ the state names with value true #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getItemAllStates](../interfaces/types-IGraph.md#getitemallstates) +[IGraph](../interfaces/types-IGraph.en.md).[getItemAllStates](../interfaces/types-IGraph.en.md#getitemallstates) #### Defined in -[runtime/graph.ts:1449](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1449) +[runtime/graph.ts:1482](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1482) ___ @@ -956,11 +982,11 @@ the state value #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getItemState](../interfaces/types-IGraph.md#getitemstate) +[IGraph](../interfaces/types-IGraph.en.md).[getItemState](../interfaces/types-IGraph.en.md#getitemstate) #### Defined in -[runtime/graph.ts:1439](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1439) +[runtime/graph.ts:1472](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1472) ___ @@ -984,11 +1010,11 @@ visibility for the item, false for invisible or unexistence for the item #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getItemVisible](../interfaces/types-IGraph.md#getitemvisible) +[IGraph](../interfaces/types-IGraph.en.md).[getItemVisible](../interfaces/types-IGraph.en.md#getitemvisible) #### Defined in -[runtime/graph.ts:1503](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1503) +[runtime/graph.ts:1536](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1536) ___ @@ -1014,11 +1040,11 @@ rendering bounding box. returns false if the item is not exist #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getRenderBBox](../interfaces/types-IGraph.md#getrenderbbox) +[IGraph](../interfaces/types-IGraph.en.md).[getRenderBBox](../interfaces/types-IGraph.en.md#getrenderbbox) #### Defined in -[runtime/graph.ts:1488](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1488) +[runtime/graph.ts:1521](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1521) ___ @@ -1041,11 +1067,11 @@ Hide the item(s). #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[hideItem](../interfaces/types-IGraph.md#hideitem) +[IGraph](../interfaces/types-IGraph.en.md).[hideItem](../interfaces/types-IGraph.en.md#hideitem) #### Defined in -[runtime/graph.ts:1319](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1319) +[runtime/graph.ts:1352](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1352) ___ @@ -1069,11 +1095,11 @@ Set state for the item. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[setItemState](../interfaces/types-IGraph.md#setitemstate) +[IGraph](../interfaces/types-IGraph.en.md).[setItemState](../interfaces/types-IGraph.en.md#setitemstate) #### Defined in -[runtime/graph.ts:1406](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1406) +[runtime/graph.ts:1439](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1439) ___ @@ -1096,11 +1122,11 @@ Show the item(s). #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[showItem](../interfaces/types-IGraph.md#showitem) +[IGraph](../interfaces/types-IGraph.en.md).[showItem](../interfaces/types-IGraph.en.md#showitem) #### Defined in -[runtime/graph.ts:1291](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1291) +[runtime/graph.ts:1324](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1324) ## Methods @@ -1124,11 +1150,11 @@ more convenient way without manually invoking `startBatch` and `stopBatch`. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[batch](../interfaces/types-IGraph.md#batch) +[IGraph](../interfaces/types-IGraph.en.md).[batch](../interfaces/types-IGraph.en.md#batch) #### Defined in -[runtime/graph.ts:2084](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2084) +[runtime/graph.ts:2121](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2121) ___ @@ -1144,11 +1170,11 @@ Indicate whether there are any actions available in the redo stack. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[canRedo](../interfaces/types-IGraph.md#canredo) +[IGraph](../interfaces/types-IGraph.en.md).[canRedo](../interfaces/types-IGraph.en.md#canredo) #### Defined in -[runtime/graph.ts:2053](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2053) +[runtime/graph.ts:2090](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2090) ___ @@ -1164,11 +1190,11 @@ Indicate whether there are any actions available in the undo stack. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[canUndo](../interfaces/types-IGraph.md#canundo) +[IGraph](../interfaces/types-IGraph.en.md).[canUndo](../interfaces/types-IGraph.en.md#canundo) #### Defined in -[runtime/graph.ts:2045](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2045) +[runtime/graph.ts:2082](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2082) ___ @@ -1190,11 +1216,11 @@ Change the renderer at runtime. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[changeRenderer](../interfaces/types-IGraph.md#changerenderer) +[IGraph](../interfaces/types-IGraph.en.md).[changeRenderer](../interfaces/types-IGraph.en.md#changerenderer) #### Defined in -[runtime/graph.ts:265](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L265) +[runtime/graph.ts:265](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L265) ___ @@ -1210,11 +1236,11 @@ Clear the graph, means remove all the items on the graph. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[clear](../interfaces/types-IGraph.md#clear) +[IGraph](../interfaces/types-IGraph.en.md).[clear](../interfaces/types-IGraph.en.md#clear) #### Defined in -[runtime/graph.ts:455](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L455) +[runtime/graph.ts:475](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L475) ___ @@ -1236,11 +1262,11 @@ Clear history stack #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[clearStack](../interfaces/types-IGraph.md#clearstack) +[IGraph](../interfaces/types-IGraph.en.md).[clearStack](../interfaces/types-IGraph.en.md#clearstack) #### Defined in -[runtime/graph.ts:2093](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2093) +[runtime/graph.ts:2130](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2130) ___ @@ -1262,11 +1288,11 @@ Execute a callback without allowing any stacking operations. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[executeWithoutStacking](../interfaces/types-IGraph.md#executewithoutstacking) +[IGraph](../interfaces/types-IGraph.en.md).[executeWithoutStacking](../interfaces/types-IGraph.en.md#executewithoutstacking) #### Defined in -[runtime/graph.ts:1987](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1987) +[runtime/graph.ts:2024](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2024) ___ @@ -1288,11 +1314,11 @@ Fit the graph center to the view center. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[fitCenter](../interfaces/types-IGraph.md#fitcenter) +[IGraph](../interfaces/types-IGraph.en.md).[fitCenter](../interfaces/types-IGraph.en.md#fitcenter) #### Defined in -[runtime/graph.ts:691](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L691) +[runtime/graph.ts:711](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L711) ___ @@ -1317,11 +1343,11 @@ Fit the graph content to the view. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[fitView](../interfaces/types-IGraph.md#fitview) +[IGraph](../interfaces/types-IGraph.en.md).[fitView](../interfaces/types-IGraph.en.md#fitview) #### Defined in -[runtime/graph.ts:623](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L623) +[runtime/graph.ts:643](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L643) ___ @@ -1344,11 +1370,11 @@ Move the graph to make the item align the view center. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[focusItem](../interfaces/types-IGraph.md#focusitem) +[IGraph](../interfaces/types-IGraph.en.md).[focusItem](../interfaces/types-IGraph.en.md#focusitem) #### Defined in -[runtime/graph.ts:706](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L706) +[runtime/graph.ts:726](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L726) ___ @@ -1362,33 +1388,7 @@ ___ #### Defined in -[runtime/graph.ts:1708](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1708) - -___ - -### getNearEdgesForNode - -▸ **getNearEdgesForNode**(`nodeId`): [`EdgeModel`](../modules/types.md#edgemodel)[] - -Retrieve the nearby edges for a given node using quadtree collision detection. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `nodeId` | `ID` | node id | - -#### Returns - -[`EdgeModel`](../modules/types.md#edgemodel)[] - -#### Implementation of - -[IGraph](../interfaces/types-IGraph.md).[getNearEdgesForNode](../interfaces/types-IGraph.md#getnearedgesfornode) - -#### Defined in - -[runtime/graph.ts:907](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L907) +[runtime/graph.ts:1745](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1745) ___ @@ -1404,33 +1404,33 @@ Retrieve the current undo stack which consists of operations that were undone #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getRedoStack](../interfaces/types-IGraph.md#getredostack) +[IGraph](../interfaces/types-IGraph.en.md).[getRedoStack](../interfaces/types-IGraph.en.md#getredostack) #### Defined in -[runtime/graph.ts:2008](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2008) +[runtime/graph.ts:2045](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2045) ___ ### getSpecification -▸ **getSpecification**(): [`Specification`](../interfaces/types-Specification.md)<`B`, `T`\> +▸ **getSpecification**(): [`Specification`](../interfaces/types-Specification.en.md)<`B`, `T`\> Get the copy of specs(configurations). #### Returns -[`Specification`](../interfaces/types-Specification.md)<`B`, `T`\> +[`Specification`](../interfaces/types-Specification.en.md)<`B`, `T`\> graph specs #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getSpecification](../interfaces/types-IGraph.md#getspecification) +[IGraph](../interfaces/types-IGraph.en.md).[getSpecification](../interfaces/types-IGraph.en.md#getspecification) #### Defined in -[runtime/graph.ts:394](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L394) +[runtime/graph.ts:394](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L394) ___ @@ -1446,11 +1446,11 @@ Retrieve the complete history stack #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getStack](../interfaces/types-IGraph.md#getstack) +[IGraph](../interfaces/types-IGraph.en.md).[getStack](../interfaces/types-IGraph.en.md#getstack) #### Defined in -[runtime/graph.ts:2017](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2017) +[runtime/graph.ts:2054](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2054) ___ @@ -1466,11 +1466,11 @@ Retrieve the current redo stack which consists of operations that could be undon #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getUndoStack](../interfaces/types-IGraph.md#getundostack) +[IGraph](../interfaces/types-IGraph.en.md).[getUndoStack](../interfaces/types-IGraph.en.md#getundostack) #### Defined in -[runtime/graph.ts:2000](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2000) +[runtime/graph.ts:2037](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2037) ___ @@ -1486,11 +1486,11 @@ Return the center of viewport, e.g. for a 500 * 500 canvas, its center is [250, #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getViewportCenter](../interfaces/types-IGraph.md#getviewportcenter) +[IGraph](../interfaces/types-IGraph.en.md).[getViewportCenter](../interfaces/types-IGraph.en.md#getviewportcenter) #### Defined in -[runtime/graph.ts:472](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L472) +[runtime/graph.ts:492](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L492) ___ @@ -1508,11 +1508,11 @@ current zoom #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getZoom](../interfaces/types-IGraph.md#getzoom) +[IGraph](../interfaces/types-IGraph.en.md).[getZoom](../interfaces/types-IGraph.en.md#getzoom) #### Defined in -[runtime/graph.ts:573](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L573) +[runtime/graph.ts:593](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L593) ___ @@ -1528,11 +1528,11 @@ Determine if history (redo/undo) is enabled. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[isHistoryEnabled](../interfaces/types-IGraph.md#ishistoryenabled) +[IGraph](../interfaces/types-IGraph.en.md).[isHistoryEnabled](../interfaces/types-IGraph.en.md#ishistoryenabled) #### Defined in -[runtime/graph.ts:1951](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1951) +[runtime/graph.ts:1988](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1988) ___ @@ -1546,7 +1546,7 @@ Layout the graph (with current configurations if cfg is not assigned). | Name | Type | Default value | | :------ | :------ | :------ | -| `options?` | [`LayoutOptions`](../modules/types.md#layoutoptions) | `undefined` | +| `options?` | [`LayoutOptions`](../modules/types.en.md#layoutoptions) | `undefined` | | `disableAnimate` | `boolean` | `false` | #### Returns @@ -1555,11 +1555,11 @@ Layout the graph (with current configurations if cfg is not assigned). #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[layout](../interfaces/types-IGraph.md#layout) +[IGraph](../interfaces/types-IGraph.en.md).[layout](../interfaces/types-IGraph.en.md#layout) #### Defined in -[runtime/graph.ts:1656](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1656) +[runtime/graph.ts:1689](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1689) ___ @@ -1575,11 +1575,11 @@ Pause stacking operation. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[pauseStacking](../interfaces/types-IGraph.md#pausestacking) +[IGraph](../interfaces/types-IGraph.en.md).[pauseStacking](../interfaces/types-IGraph.en.md#pausestacking) #### Defined in -[runtime/graph.ts:1970](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1970) +[runtime/graph.ts:2007](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2007) ___ @@ -1603,11 +1603,11 @@ Push the operation(s) onto the specified stack #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[pushStack](../interfaces/types-IGraph.md#pushstack) +[IGraph](../interfaces/types-IGraph.en.md).[pushStack](../interfaces/types-IGraph.en.md#pushstack) #### Defined in -[runtime/graph.ts:1962](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1962) +[runtime/graph.ts:1999](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1999) ___ @@ -1623,11 +1623,11 @@ Revert recent n operation(s) performed on the graph. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[redo](../interfaces/types-IGraph.md#redo) +[IGraph](../interfaces/types-IGraph.en.md).[redo](../interfaces/types-IGraph.en.md#redo) #### Defined in -[runtime/graph.ts:2037](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2037) +[runtime/graph.ts:2074](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2074) ___ @@ -1643,11 +1643,11 @@ Resume stacking operation. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[resumeStacking](../interfaces/types-IGraph.md#resumestacking) +[IGraph](../interfaces/types-IGraph.en.md).[resumeStacking](../interfaces/types-IGraph.en.md#resumestacking) #### Defined in -[runtime/graph.ts:1978](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1978) +[runtime/graph.ts:2015](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2015) ___ @@ -1671,11 +1671,11 @@ Rotate the graph with a relative angle. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[rotate](../interfaces/types-IGraph.md#rotate) +[IGraph](../interfaces/types-IGraph.en.md).[rotate](../interfaces/types-IGraph.en.md#rotate) #### Defined in -[runtime/graph.ts:583](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L583) +[runtime/graph.ts:603](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L603) ___ @@ -1699,11 +1699,11 @@ Rotate the graph to an absolute angle. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[rotateTo](../interfaces/types-IGraph.md#rotateto) +[IGraph](../interfaces/types-IGraph.en.md).[rotateTo](../interfaces/types-IGraph.en.md#rotateto) #### Defined in -[runtime/graph.ts:605](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L605) +[runtime/graph.ts:625](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L625) ___ @@ -1721,11 +1721,11 @@ treated as a single operation when undoing or redoing. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[startBatch](../interfaces/types-IGraph.md#startbatch) +[IGraph](../interfaces/types-IGraph.en.md).[startBatch](../interfaces/types-IGraph.en.md#startbatch) #### Defined in -[runtime/graph.ts:2063](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2063) +[runtime/graph.ts:2100](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2100) ___ @@ -1743,11 +1743,11 @@ treated as a single operation when undoing or redoing. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[stopBatch](../interfaces/types-IGraph.md#stopbatch) +[IGraph](../interfaces/types-IGraph.en.md).[stopBatch](../interfaces/types-IGraph.en.md#stopbatch) #### Defined in -[runtime/graph.ts:2073](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2073) +[runtime/graph.ts:2110](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2110) ___ @@ -1763,11 +1763,11 @@ Some layout algorithms has many iterations which can be stopped at any time. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[stopLayout](../interfaces/types-IGraph.md#stoplayout) +[IGraph](../interfaces/types-IGraph.en.md).[stopLayout](../interfaces/types-IGraph.en.md#stoplayout) #### Defined in -[runtime/graph.ts:1700](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1700) +[runtime/graph.ts:1737](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1737) ___ @@ -1783,11 +1783,11 @@ Stop the current transition of transform immediately. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[stopTransformTransition](../interfaces/types-IGraph.md#stoptransformtransition) +[IGraph](../interfaces/types-IGraph.en.md).[stopTransformTransition](../interfaces/types-IGraph.en.md#stoptransformtransition) #### Defined in -[runtime/graph.ts:490](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L490) +[runtime/graph.ts:510](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L510) ___ @@ -1810,11 +1810,11 @@ Transform the graph with a CSS-Transform-like syntax. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[transform](../interfaces/types-IGraph.md#transform) +[IGraph](../interfaces/types-IGraph.en.md).[transform](../interfaces/types-IGraph.en.md#transform) #### Defined in -[runtime/graph.ts:476](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L476) +[runtime/graph.ts:496](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L496) ___ @@ -1837,11 +1837,11 @@ Move the graph with a relative distance under viewport coordinates. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[translate](../interfaces/types-IGraph.md#translate) +[IGraph](../interfaces/types-IGraph.en.md).[translate](../interfaces/types-IGraph.en.md#translate) #### Defined in -[runtime/graph.ts:500](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L500) +[runtime/graph.ts:520](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L520) ___ @@ -1855,7 +1855,7 @@ Move the graph to destination under viewport coordinates. | Name | Type | Description | | :------ | :------ | :------ | -| `destination` | `PointLike` | destination under viewport coordinates. | +| `destination` | `Point` | destination under viewport coordinates. | | `effectTiming?` | `Partial`<`Pick`<`IAnimationEffectTiming`, ``"duration"`` \| ``"easing"`` \| ``"easingFunction"``\>\> | animation configurations | #### Returns @@ -1864,11 +1864,11 @@ Move the graph to destination under viewport coordinates. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[translateTo](../interfaces/types-IGraph.md#translateto) +[IGraph](../interfaces/types-IGraph.en.md).[translateTo](../interfaces/types-IGraph.en.md#translateto) #### Defined in -[runtime/graph.ts:521](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L521) +[runtime/graph.ts:541](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L541) ___ @@ -1884,17 +1884,17 @@ Restore n operations that were last n reverted on the graph. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[undo](../interfaces/types-IGraph.md#undo) +[IGraph](../interfaces/types-IGraph.en.md).[undo](../interfaces/types-IGraph.en.md#undo) #### Defined in -[runtime/graph.ts:2027](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2027) +[runtime/graph.ts:2064](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2064) ___ ### updateSpecification -▸ **updateSpecification**(`spec`): [`Specification`](../interfaces/types-Specification.md)<`B`, `T`\> +▸ **updateSpecification**(`spec`): [`Specification`](../interfaces/types-Specification.en.md)<`B`, `T`\> Update the specs(configurations). @@ -1902,19 +1902,19 @@ Update the specs(configurations). | Name | Type | | :------ | :------ | -| `spec` | [`Specification`](../interfaces/types-Specification.md)<`B`, `T`\> | +| `spec` | [`Specification`](../interfaces/types-Specification.en.md)<`B`, `T`\> | #### Returns -[`Specification`](../interfaces/types-Specification.md)<`B`, `T`\> +[`Specification`](../interfaces/types-Specification.en.md)<`B`, `T`\> #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[updateSpecification](../interfaces/types-IGraph.md#updatespecification) +[IGraph](../interfaces/types-IGraph.en.md).[updateSpecification](../interfaces/types-IGraph.en.md#updatespecification) #### Defined in -[runtime/graph.ts:367](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L367) +[runtime/graph.ts:367](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L367) ___ @@ -1936,11 +1936,11 @@ Update the theme specs (configurations). #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[updateTheme](../interfaces/types-IGraph.md#updatetheme) +[IGraph](../interfaces/types-IGraph.en.md).[updateTheme](../interfaces/types-IGraph.en.md#updatetheme) #### Defined in -[runtime/graph.ts:373](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L373) +[runtime/graph.ts:373](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L373) ___ @@ -1955,7 +1955,7 @@ Zoom the graph with a relative ratio. | Name | Type | Description | | :------ | :------ | :------ | | `ratio` | `number` | relative ratio to zoom | -| `origin?` | `PointLike` | origin under viewport coordinates. | +| `origin?` | `Point` | origin under viewport coordinates. | | `effectTiming?` | `Partial`<`Pick`<`IAnimationEffectTiming`, ``"duration"`` \| ``"easing"`` \| ``"easingFunction"``\>\> | animation configurations | #### Returns @@ -1964,11 +1964,11 @@ Zoom the graph with a relative ratio. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[zoom](../interfaces/types-IGraph.md#zoom) +[IGraph](../interfaces/types-IGraph.en.md).[zoom](../interfaces/types-IGraph.en.md#zoom) #### Defined in -[runtime/graph.ts:535](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L535) +[runtime/graph.ts:555](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L555) ___ @@ -1992,11 +1992,11 @@ Zoom the graph to a specified ratio. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[zoomTo](../interfaces/types-IGraph.md#zoomto) +[IGraph](../interfaces/types-IGraph.en.md).[zoomTo](../interfaces/types-IGraph.en.md#zoomto) #### Defined in -[runtime/graph.ts:557](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L557) +[runtime/graph.ts:577](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L577) ## Plugin @@ -2018,11 +2018,11 @@ Add plugin(s) to graph. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[addPlugins](../interfaces/types-IGraph.md#addplugins) +[IGraph](../interfaces/types-IGraph.en.md).[addPlugins](../interfaces/types-IGraph.en.md#addplugins) #### Defined in -[runtime/graph.ts:1804](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1804) +[runtime/graph.ts:1841](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1841) ___ @@ -2044,11 +2044,11 @@ Remove plugin(s) from graph. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[removePlugins](../interfaces/types-IGraph.md#removeplugins) +[IGraph](../interfaces/types-IGraph.en.md).[removePlugins](../interfaces/types-IGraph.en.md#removeplugins) #### Defined in -[runtime/graph.ts:1857](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L1857) +[runtime/graph.ts:1894](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L1894) ## Properties @@ -2058,7 +2058,7 @@ Remove plugin(s) from graph. #### Defined in -[runtime/graph.ts:84](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L84) +[runtime/graph.ts:84](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L84) ___ @@ -2068,11 +2068,11 @@ ___ #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[canvas](../interfaces/types-IGraph.md#canvas) +[IGraph](../interfaces/types-IGraph.en.md).[canvas](../interfaces/types-IGraph.en.md#canvas) #### Defined in -[runtime/graph.ts:74](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L74) +[runtime/graph.ts:74](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L74) ___ @@ -2082,11 +2082,11 @@ ___ #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[container](../interfaces/types-IGraph.md#container) +[IGraph](../interfaces/types-IGraph.en.md).[container](../interfaces/types-IGraph.en.md#container) #### Defined in -[runtime/graph.ts:76](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L76) +[runtime/graph.ts:76](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L76) ___ @@ -2096,11 +2096,11 @@ ___ #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[destroyed](../interfaces/types-IGraph.md#destroyed) +[IGraph](../interfaces/types-IGraph.en.md).[destroyed](../interfaces/types-IGraph.en.md#destroyed) #### Defined in -[runtime/graph.ts:78](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L78) +[runtime/graph.ts:78](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L78) ___ @@ -2110,11 +2110,11 @@ ___ #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[hooks](../interfaces/types-IGraph.md#hooks) +[IGraph](../interfaces/types-IGraph.en.md).[hooks](../interfaces/types-IGraph.en.md#hooks) #### Defined in -[runtime/graph.ts:72](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L72) +[runtime/graph.ts:72](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L72) ___ @@ -2124,11 +2124,11 @@ ___ #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[rendererType](../interfaces/types-IGraph.md#renderertype) +[IGraph](../interfaces/types-IGraph.en.md).[rendererType](../interfaces/types-IGraph.en.md#renderertype) #### Defined in -[runtime/graph.ts:80](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L80) +[runtime/graph.ts:80](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L80) ___ @@ -2138,11 +2138,11 @@ ___ #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[transientCanvas](../interfaces/types-IGraph.md#transientcanvas) +[IGraph](../interfaces/types-IGraph.en.md).[transientCanvas](../interfaces/types-IGraph.en.md#transientcanvas) #### Defined in -[runtime/graph.ts:82](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L82) +[runtime/graph.ts:82](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L82) ## Tree @@ -2166,11 +2166,11 @@ Collapse sub tree(s). #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[collapse](../interfaces/types-IGraph.md#collapse) +[IGraph](../interfaces/types-IGraph.en.md).[collapse](../interfaces/types-IGraph.en.md#collapse) #### Defined in -[runtime/graph.ts:2109](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2109) +[runtime/graph.ts:2146](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2146) ___ @@ -2194,11 +2194,11 @@ Expand sub tree(s). #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[expand](../interfaces/types-IGraph.md#expand) +[IGraph](../interfaces/types-IGraph.en.md).[expand](../interfaces/types-IGraph.en.md#expand) #### Defined in -[runtime/graph.ts:2125](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L2125) +[runtime/graph.ts:2162](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L2162) ## View @@ -2222,11 +2222,11 @@ rendering coordinate #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getCanvasByClient](../interfaces/types-IGraph.md#getcanvasbyclient) +[IGraph](../interfaces/types-IGraph.en.md).[getCanvasByClient](../interfaces/types-IGraph.en.md#getcanvasbyclient) #### Defined in -[runtime/graph.ts:804](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L804) +[runtime/graph.ts:824](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L824) ___ @@ -2250,11 +2250,11 @@ canvas dom (viewport) coordinate #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getCanvasByViewport](../interfaces/types-IGraph.md#getcanvasbyviewport) +[IGraph](../interfaces/types-IGraph.en.md).[getCanvasByViewport](../interfaces/types-IGraph.en.md#getcanvasbyviewport) #### Defined in -[runtime/graph.ts:773](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L773) +[runtime/graph.ts:793](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L793) ___ @@ -2278,11 +2278,11 @@ browser coordinate #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getClientByCanvas](../interfaces/types-IGraph.md#getclientbycanvas) +[IGraph](../interfaces/types-IGraph.en.md).[getClientByCanvas](../interfaces/types-IGraph.en.md#getclientbycanvas) #### Defined in -[runtime/graph.ts:793](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L793) +[runtime/graph.ts:813](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L813) ___ @@ -2300,11 +2300,11 @@ Get the size of the graph canvas. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getSize](../interfaces/types-IGraph.md#getsize) +[IGraph](../interfaces/types-IGraph.en.md).[getSize](../interfaces/types-IGraph.en.md#getsize) #### Defined in -[runtime/graph.ts:745](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L745) +[runtime/graph.ts:765](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L765) ___ @@ -2328,11 +2328,11 @@ rendering coordinate #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[getViewportByCanvas](../interfaces/types-IGraph.md#getviewportbycanvas) +[IGraph](../interfaces/types-IGraph.en.md).[getViewportByCanvas](../interfaces/types-IGraph.en.md#getviewportbycanvas) #### Defined in -[runtime/graph.ts:783](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L783) +[runtime/graph.ts:803](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L803) ___ @@ -2354,8 +2354,8 @@ Set the size for the graph canvas. #### Implementation of -[IGraph](../interfaces/types-IGraph.md).[setSize](../interfaces/types-IGraph.md#setsize) +[IGraph](../interfaces/types-IGraph.en.md).[setSize](../interfaces/types-IGraph.en.md#setsize) #### Defined in -[runtime/graph.ts:755](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/runtime/graph.ts#L755) +[runtime/graph.ts:775](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/runtime/graph.ts#L775) diff --git a/packages/site/docs/apis/classes/graph-Graph.zh.md b/packages/site/docs/apis/classes/graph-Graph.zh.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.md b/packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.en.md similarity index 69% rename from packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.md rename to packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.en.md index 69bc7c67b6..0c9d6d770d 100644 --- a/packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.md +++ b/packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.en.md @@ -1,8 +1,8 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [behaviors](../modules/behaviors.md) / ActivateRelationsOptions +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [behaviors](../modules/behaviors.en.md) / ActivateRelationsOptions # Interface: ActivateRelationsOptions -[behaviors](../modules/behaviors.md).ActivateRelationsOptions +[behaviors](../modules/behaviors.en.md).ActivateRelationsOptions ## Properties @@ -14,7 +14,7 @@ Defaults to `"selected"`. #### Defined in -[stdlib/behavior/activate-relations.ts:37](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/activate-relations.ts#L37) +[stdlib/behavior/activate-relations.ts:37](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L37) ___ @@ -28,13 +28,13 @@ If set to false, `trigger` options will be ignored. #### Defined in -[stdlib/behavior/activate-relations.ts:24](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/activate-relations.ts#L24) +[stdlib/behavior/activate-relations.ts:24](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L24) ___ ### shouldBegin -• `Optional` **shouldBegin**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.md)) => `boolean` +• `Optional` **shouldBegin**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.en.md)) => `boolean` #### Type declaration @@ -46,7 +46,7 @@ Whether allow the behavior happen on the current item. | Name | Type | | :------ | :------ | -| `event` | [`IG6GraphEvent`](types-IG6GraphEvent.md) | +| `event` | [`IG6GraphEvent`](types-IG6GraphEvent.en.md) | ##### Returns @@ -54,13 +54,13 @@ Whether allow the behavior happen on the current item. #### Defined in -[stdlib/behavior/activate-relations.ts:42](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/activate-relations.ts#L42) +[stdlib/behavior/activate-relations.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L42) ___ ### shouldUpdate -• `Optional` **shouldUpdate**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.md)) => `boolean` +• `Optional` **shouldUpdate**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.en.md)) => `boolean` #### Type declaration @@ -74,7 +74,7 @@ manage states or data manually | Name | Type | | :------ | :------ | -| `event` | [`IG6GraphEvent`](types-IG6GraphEvent.md) | +| `event` | [`IG6GraphEvent`](types-IG6GraphEvent.en.md) | ##### Returns @@ -82,7 +82,7 @@ manage states or data manually #### Defined in -[stdlib/behavior/activate-relations.ts:48](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/activate-relations.ts#L48) +[stdlib/behavior/activate-relations.ts:48](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L48) ___ @@ -96,4 +96,4 @@ Could be "click", "mouseenter". #### Defined in -[stdlib/behavior/activate-relations.ts:30](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/activate-relations.ts#L30) +[stdlib/behavior/activate-relations.ts:30](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L30) diff --git a/packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.zh.md b/packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.zh.md new file mode 100644 index 0000000000..2fb80f2dc3 --- /dev/null +++ b/packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.zh.md @@ -0,0 +1,99 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [行为](../modules/behaviors.zh.md ) / 激活关系选项 + + # 接口:ActivateRelationsOptions + + [行为](../modules/behaviors.zh.md).ActivateRelationsOptions + + ## 特性 + + ### 活动状态 + + • `可选` **activeState**:``“已选择”`` + + 默认为“选定”。 + + #### 定义于 + + [stdlib/behavior/activate-relations.ts:37](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L37) + + ___ + + ### 多种的 + + • `可选` **多个**:`布尔值` + + 是否允许多选。 + 默认为 true。 + 如果设置为 false,“trigger”选项将被忽略。 + + #### 定义于 + + [stdlib/behavior/activate-relations.ts:24](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L24) + + ___ + + ### 应该开始 + + • `可选` **shouldBegin**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.zh.md)) => `boolean` + + #### 类型声明 + + ▸ (`事件`): `布尔值` + + 是否允许该行为发生在当前项目上。 + + ##### 参数 + + | 名称 | 类型 | + | :------ | :------ | + | `事件` | [`IG6GraphEvent`](types-IG6GraphEvent.zh.md) | + + ##### 返回 + + `布尔值` + + #### 定义于 + + [stdlib/behavior/activate-relations.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L42) + + ___ + + ### 应该更新 + + • `可选` **shouldUpdate**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.zh.md)) => `boolean` + + #### 类型声明 + + ▸ (`事件`): `布尔值` + + 是否更新项目状态。 + 如果它返回 false,您可能会监听 `eventName` 并 + 手动管理状态或数据 + + ##### 参数 + + | 名称 | 类型 | + | :------ | :------ | + | `事件` | [`IG6GraphEvent`](types-IG6GraphEvent.zh.md) | + + ##### 返回 + + `布尔值` + + #### 定义于 + + [stdlib/behavior/activate-relations.ts:48](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L48) + + ___ + + ### 扳机 + + • `可选` **触发**:``"点击"`` \| ``“鼠标输入”`` + + 单击鼠标按下该键以应用多项选择。 + 默认为“单击”。 + 可以是“单击”、“鼠标输入”。 + + #### 定义于 + + [stdlib/behavior/activate-relations.ts:30](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L30) \ No newline at end of file diff --git a/packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.md b/packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.en.md similarity index 81% rename from packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.md rename to packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.en.md index 57ce8bd876..2090c4276a 100644 --- a/packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.md +++ b/packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.en.md @@ -1,8 +1,8 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [behaviors](../modules/behaviors.md) / BrushSelectOptions +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [behaviors](../modules/behaviors.en.md) / BrushSelectOptions # Interface: BrushSelectOptions -[behaviors](../modules/behaviors.md).BrushSelectOptions +[behaviors](../modules/behaviors.en.md).BrushSelectOptions ## Properties @@ -27,7 +27,7 @@ The shape style of the brush while selecting. #### Defined in -[stdlib/behavior/brush-select.ts:46](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/brush-select.ts#L46) +[stdlib/behavior/brush-select.ts:46](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L46) ___ @@ -39,7 +39,7 @@ The event name to trigger when select/unselect an item. #### Defined in -[stdlib/behavior/brush-select.ts:42](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/brush-select.ts#L42) +[stdlib/behavior/brush-select.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L42) ___ @@ -53,7 +53,7 @@ Should be an array of "node", "edge", or "combo". #### Defined in -[stdlib/behavior/brush-select.ts:32](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/brush-select.ts#L32) +[stdlib/behavior/brush-select.ts:32](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L32) ___ @@ -86,7 +86,7 @@ A callback be called after deselecting. #### Defined in -[stdlib/behavior/brush-select.ts:77](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/brush-select.ts#L77) +[stdlib/behavior/brush-select.ts:77](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L77) ___ @@ -115,7 +115,7 @@ A callback be called after selecting. #### Defined in -[stdlib/behavior/brush-select.ts:73](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/brush-select.ts#L73) +[stdlib/behavior/brush-select.ts:73](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L73) ___ @@ -127,7 +127,7 @@ The mode to compose the selections from times of brush #### Defined in -[stdlib/behavior/brush-select.ts:54](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/brush-select.ts#L54) +[stdlib/behavior/brush-select.ts:54](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L54) ___ @@ -141,13 +141,13 @@ Can be set to "active", "highlighted", etc. #### Defined in -[stdlib/behavior/brush-select.ts:38](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/brush-select.ts#L38) +[stdlib/behavior/brush-select.ts:38](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L38) ___ ### shouldBegin -• **shouldBegin**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.md)) => `boolean` +• **shouldBegin**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.en.md)) => `boolean` #### Type declaration @@ -159,7 +159,7 @@ Whether allow the behavior happen on the current item. | Name | Type | | :------ | :------ | -| `event` | [`IG6GraphEvent`](types-IG6GraphEvent.md) | +| `event` | [`IG6GraphEvent`](types-IG6GraphEvent.en.md) | ##### Returns @@ -167,7 +167,7 @@ Whether allow the behavior happen on the current item. #### Defined in -[stdlib/behavior/brush-select.ts:58](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/brush-select.ts#L58) +[stdlib/behavior/brush-select.ts:58](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L58) ___ @@ -198,7 +198,7 @@ manage states or data manually #### Defined in -[stdlib/behavior/brush-select.ts:64](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/brush-select.ts#L64) +[stdlib/behavior/brush-select.ts:64](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L64) ___ @@ -212,4 +212,4 @@ Could be "drag", "shift", "ctrl", "alt", or "meta". #### Defined in -[stdlib/behavior/brush-select.ts:26](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/behavior/brush-select.ts#L26) +[stdlib/behavior/brush-select.ts:26](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L26) diff --git a/packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.zh.md b/packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.zh.md new file mode 100644 index 0000000000..970213d1ff --- /dev/null +++ b/packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.zh.md @@ -0,0 +1,215 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [行为](../modules/behaviors.zh.md ) / 画笔选择选项 + + # 接口:BrushSelectOptions + + [行为](../modules/behaviors.zh.md).BrushSelectOptions + + ## 特性 + + ###画笔样式 + + • **brushStyle**:`对象` + + 选择时画笔的形状样式。 + + #### 索引签名 + + ▪ [key: `string`]: `unknown` + + #### 类型声明 + + | 名称 | 类型 | + | :------ | :------ | + | `填充?` | `字符串` | + | `填充不透明度?` | `数字` | + | `线宽?` | `数字` | + | `中风?` | `字符串` | + + #### 定义于 + + [stdlib/behavior/brush-select.ts:46](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L46) + + ___ + + ### 事件名称 + + • **事件名称**:`字符串` + + 选择/取消选择项目时触发的事件名称。 + + #### 定义于 + + [stdlib/behavior/brush-select.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L42) + + ___ + + ### 项目类型 + + • **itemTypes**: (``"node"`` \| ``"edge"`` \| ``"combo"``)[] + + 可以选择的项目类型。 + 默认为`[“节点”]`。 + 应该是“节点”、“边”或“组合”的数组。 + + #### 定义于 + + [stdlib/behavior/brush-select.ts:32](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L32) + + ___ + + ### on取消选择 + + • **onDeselect**: (`selectedIds`: { `combos`: `ID`[] ; `edges`: `ID`[] ; `nodes`: `ID`[] }, `deselectedIds`: { ` 组合`:`ID`[] ;`边`:`ID`[] ;`节点`:`ID`[] }) => `void` + + #### 类型声明 + + ▸ (`selectedIds`, `deselectedIds`): `void` + + 取消选择后调用回调。 + + ##### 参数 + + | 名称 | 类型 | + | :------ | :------ | + | `selectedIds` | `对象` | + | `selectedIds.combos` | `ID`[] | + | `selectedIds.edges` | `ID`[] | + | `selectedIds.nodes` | `ID`[] | + | `取消选择的Ids` | `对象` | + | `deselectedIds.combos` | `ID`[] | + | `deselectedIds.edges` | `ID`[] | + | `deselectedIds.nodes` | `ID`[] | + + ##### 返回 + + `无效` + + #### 定义于 + + [stdlib/behavior/brush-select.ts:77](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L77) + + ___ + + ### on选择 + + • **onSelect**: (`selectedIds`: { `combos`: `ID`[] ; `edges`: `ID`[] ; `nodes`: `ID`[] }) => `void` + + #### 类型声明 + + ▸ (`selectedIds`): `void` + + 选择后会调用回调。 + + ##### 参数 + + | 名称 | 类型 | + | :------ | :------ | + | `selectedIds` | `对象` | + | `selectedIds.combos` | `ID`[] | + | `selectedIds.edges` | `ID`[] | + | `selectedIds.nodes` | `ID`[] | + + ##### 返回 + + `无效` + + #### 定义于 + + [stdlib/behavior/brush-select.ts:73](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L73) + + ___ + + ### 选择设置模式 + + • **selectSetMode**: ``"union"`` \| ``“相交”`` \| ``“差异”`` \| ``“最新”`` + + 笔刷次数组成选区的模式 + + #### 定义于 + + [stdlib/behavior/brush-select.ts:54](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L54) + + ___ + + ### 选定状态 + + • **selectedState**:``“已选择”`` + + 选择时要应用的状态。 + 默认为“选定”。 + 可以设置为“活动”、“突出显示”等。 + + #### 定义于 + + [stdlib/behavior/brush-select.ts:38](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L38) + + ___ + + ### 应该开始 + + • **shouldBegin**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.zh.md)) => `boolean` + + #### 类型声明 + + ▸ (`事件`): `布尔值` + + 是否允许该行为发生在当前项目上。 + + ##### 参数 + + | 名称 | 类型 | + | :------ | :------ | + | `事件` | [`IG6GraphEvent`](types-IG6GraphEvent.zh.md) | + + ##### 返回 + + `布尔值` + + #### 定义于 + + [stdlib/behavior/brush-select.ts:58](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L58) + + ___ + + ### 应该更新 + + • **shouldUpdate**: (`itemType`: `ITEM_TYPE`, `id`: `ID`, `action`: ``"选择"`` \| ``"取消选择"``, `self`: ` 默认`) => `布尔值` + + #### 类型声明 + + ▸ (`itemType`, `id`, `action`, `self`): `boolean` + + 是否更新项目状态。 + 如果它返回 false,您可能会监听 `eventName` 并 + 手动管理状态或数据 + + ##### 参数 + + | 名称 | 类型 | + | :------ | :------ | + | `项目类型` | `ITEM_TYPE` | + | `id` | `ID` | + | `行动` | ``“选择”`` \| ``“取消选择”`` | + | `自我` | `默认` | + + ##### 返回 + + `布尔值` + + #### 定义于 + + [stdlib/behavior/brush-select.ts:64](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L64) + + ___ + + ### 扳机 + + • **触发**:``“拖动”`` \| ``“转变”`` \| ``“ctrl”`` \| ``“替代”`` \| ``“元”`` + + 单击鼠标按下该键以应用多项选择。 + 默认为“移位”。 + 可以是“drag”、“shift”、“ctrl”、“alt”或“meta”。 + + #### 定义于 + + [stdlib/behavior/brush-select.ts:26](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L26) \ No newline at end of file diff --git a/packages/site/docs/apis/interfaces/plugins-LegendConfig.md b/packages/site/docs/apis/interfaces/plugins-LegendConfig.en.md similarity index 65% rename from packages/site/docs/apis/interfaces/plugins-LegendConfig.md rename to packages/site/docs/apis/interfaces/plugins-LegendConfig.en.md index 08307075cc..54688eeed2 100644 --- a/packages/site/docs/apis/interfaces/plugins-LegendConfig.md +++ b/packages/site/docs/apis/interfaces/plugins-LegendConfig.en.md @@ -1,8 +1,8 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [plugins](../modules/plugins.md) / LegendConfig +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [plugins](../modules/plugins.en.md) / LegendConfig # Interface: LegendConfig -[plugins](../modules/plugins.md).LegendConfig +[plugins](../modules/plugins.en.md).LegendConfig ## Hierarchy @@ -18,7 +18,7 @@ #### Defined in -[stdlib/plugin/legend/index.ts:55](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/legend/index.ts#L55) +[stdlib/plugin/legend/index.ts:55](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L55) ___ @@ -32,7 +32,7 @@ IPluginBaseConfig.className #### Defined in -[stdlib/plugin/legend/index.ts:47](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/legend/index.ts#L47) +[stdlib/plugin/legend/index.ts:47](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L47) ___ @@ -46,7 +46,7 @@ IPluginBaseConfig.container #### Defined in -[stdlib/plugin/legend/index.ts:45](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/legend/index.ts#L45) +[stdlib/plugin/legend/index.ts:45](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L45) ___ @@ -56,13 +56,13 @@ ___ #### Defined in -[stdlib/plugin/legend/index.ts:61](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/legend/index.ts#L61) +[stdlib/plugin/legend/index.ts:61](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L61) ___ ### graph -• `Optional` **graph**: [`IGraph`](types-IGraph.md)<`BehaviorRegistry`, `ThemeRegistry`\> +• `Optional` **graph**: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\> #### Inherited from @@ -70,7 +70,7 @@ IPluginBaseConfig.graph #### Defined in -[types/plugin.ts:7](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/plugin.ts#L7) +[types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[stdlib/plugin/legend/index.ts:57](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/legend/index.ts#L57) +[stdlib/plugin/legend/index.ts:57](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L57) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[stdlib/plugin/legend/index.ts:59](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/legend/index.ts#L59) +[stdlib/plugin/legend/index.ts:59](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L59) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[stdlib/plugin/legend/index.ts:51](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/legend/index.ts#L51) +[stdlib/plugin/legend/index.ts:51](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L51) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[stdlib/plugin/legend/index.ts:53](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/legend/index.ts#L53) +[stdlib/plugin/legend/index.ts:53](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L53) ___ @@ -120,4 +120,4 @@ ___ #### Defined in -[stdlib/plugin/legend/index.ts:49](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/legend/index.ts#L49) +[stdlib/plugin/legend/index.ts:49](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L49) diff --git a/packages/site/docs/apis/interfaces/plugins-LegendConfig.zh.md b/packages/site/docs/apis/interfaces/plugins-LegendConfig.zh.md new file mode 100644 index 0000000000..cdf31439ec --- /dev/null +++ b/packages/site/docs/apis/interfaces/plugins-LegendConfig.zh.md @@ -0,0 +1,123 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [插件](../modules/plugins.zh.md ) / LegendConfig + + # 接口:LegendConfig + + [插件](../modules/plugins.zh.md).LegendConfig + + ## 等级制度 + + - `IPluginBaseConfig` + + ↳ **`图例配置`** + + ## 特性 + + ### 活动状态 + + • `可选` **activeState**:`字符串` + + #### 定义于 + + [stdlib/plugin/legend/index.ts:55](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L55) + + ___ + + ### 班级名称 + + • `可选` **类名**:`字符串` + + #### 覆盖 + + IPluginBaseConfig.className + + #### 定义于 + + [stdlib/plugin/legend/index.ts:47](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L47) + + ___ + + ### 容器 + + • `可选` **容器**:`HTMLDivElement` + + #### 覆盖 + + IPluginBaseConfig.container + + #### 定义于 + + [stdlib/plugin/legend/index.ts:45](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L45) + + ___ + + ### 边缘 + + • `可选` **边缘**:`ItemLegendConfig` + + #### 定义于 + + [stdlib/plugin/legend/index.ts:61](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L61) + + ___ + + ### 图表 + + • `可选` **graph**: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> + + ####继承自 + + IPluginBaseConfig.graph + + #### 定义于 + + [types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7) + + ___ + + ### 非活动状态 + + • `可选` **inactiveState**:`字符串` + + #### 定义于 + + [stdlib/plugin/legend/index.ts:57](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L57) + + ___ + + ### 节点 + + • `可选` **节点**:`ItemLegendConfig` + + #### 定义于 + + [stdlib/plugin/legend/index.ts:59](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L59) + + ___ + + ### 方向 + + • `可选` **方向**:``"水平"`` \| ``“垂直”`` + + #### 定义于 + + [stdlib/plugin/legend/index.ts:51](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L51) + + ___ + + ### 选定状态 + + • `可选` **selectedState**:`字符串` + + #### 定义于 + + [stdlib/plugin/legend/index.ts:53](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L53) + + ___ + + ### 尺寸 + + • `可选` **尺寸**:``"fit-content"`` \| [`字符串`\| `数字`、`字符串` \| `数字`] + + #### 定义于 + + [stdlib/plugin/legend/index.ts:49](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L49) \ No newline at end of file diff --git a/packages/site/docs/apis/interfaces/plugins-MiniMapConfig.md b/packages/site/docs/apis/interfaces/plugins-MiniMapConfig.en.md similarity index 68% rename from packages/site/docs/apis/interfaces/plugins-MiniMapConfig.md rename to packages/site/docs/apis/interfaces/plugins-MiniMapConfig.en.md index fe914b91bb..c2070a2284 100644 --- a/packages/site/docs/apis/interfaces/plugins-MiniMapConfig.md +++ b/packages/site/docs/apis/interfaces/plugins-MiniMapConfig.en.md @@ -1,8 +1,8 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [plugins](../modules/plugins.md) / MiniMapConfig +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [plugins](../modules/plugins.en.md) / MiniMapConfig # Interface: MiniMapConfig -[plugins](../modules/plugins.md).MiniMapConfig +[plugins](../modules/plugins.en.md).MiniMapConfig ## Hierarchy @@ -22,7 +22,7 @@ IPluginBaseConfig.className #### Defined in -[stdlib/plugin/minimap/index.ts:19](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/minimap/index.ts#L19) +[stdlib/plugin/minimap/index.ts:19](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L19) ___ @@ -36,7 +36,7 @@ IPluginBaseConfig.container #### Defined in -[stdlib/plugin/minimap/index.ts:26](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/minimap/index.ts#L26) +[stdlib/plugin/minimap/index.ts:26](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L26) ___ @@ -46,13 +46,13 @@ ___ #### Defined in -[stdlib/plugin/minimap/index.ts:22](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/minimap/index.ts#L22) +[stdlib/plugin/minimap/index.ts:22](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L22) ___ ### graph -• `Optional` **graph**: [`IGraph`](types-IGraph.md)<`BehaviorRegistry`, `ThemeRegistry`\> +• `Optional` **graph**: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\> #### Inherited from @@ -60,7 +60,7 @@ IPluginBaseConfig.graph #### Defined in -[types/plugin.ts:7](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/plugin.ts#L7) +[types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[stdlib/plugin/minimap/index.ts:25](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/minimap/index.ts#L25) +[stdlib/plugin/minimap/index.ts:25](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L25) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[stdlib/plugin/minimap/index.ts:20](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/minimap/index.ts#L20) +[stdlib/plugin/minimap/index.ts:20](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L20) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[stdlib/plugin/minimap/index.ts:24](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/minimap/index.ts#L24) +[stdlib/plugin/minimap/index.ts:24](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L24) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[stdlib/plugin/minimap/index.ts:23](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/minimap/index.ts#L23) +[stdlib/plugin/minimap/index.ts:23](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L23) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[stdlib/plugin/minimap/index.ts:21](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/minimap/index.ts#L21) +[stdlib/plugin/minimap/index.ts:21](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L21) ___ @@ -120,4 +120,4 @@ ___ #### Defined in -[stdlib/plugin/minimap/index.ts:18](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/minimap/index.ts#L18) +[stdlib/plugin/minimap/index.ts:18](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L18) diff --git a/packages/site/docs/apis/interfaces/plugins-MiniMapConfig.zh.md b/packages/site/docs/apis/interfaces/plugins-MiniMapConfig.zh.md new file mode 100644 index 0000000000..c91f7206e3 --- /dev/null +++ b/packages/site/docs/apis/interfaces/plugins-MiniMapConfig.zh.md @@ -0,0 +1,123 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [插件](../modules/plugins.zh.md ) / 小地图配置 + + # 接口:MiniMapConfig + + [插件](../modules/plugins.zh.md).MiniMapConfig + + ## 等级制度 + + - `IPluginBaseConfig` + + ↳ **`MiniMapConfig`** + + ## 特性 + + ### 班级名称 + + • `可选` **类名**:`字符串` + + #### 覆盖 + + IPluginBaseConfig.className + + #### 定义于 + + [stdlib/plugin/minimap/index.ts:19](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L19) + + ___ + + ### 容器 + + • `可选` **容器**:`HTMLDivElement` + + #### 覆盖 + + IPluginBaseConfig.container + + #### 定义于 + + [stdlib/plugin/minimap/index.ts:26](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L26) + + ___ + + ### 委托样式 + + • `可选` **delegateStyle**:`Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `动画?`: `IAnimates` ; `lod?`: `数字`; `可见?`: `布尔值` }\> + + #### 定义于 + + [stdlib/plugin/minimap/index.ts:22](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L22) + + ___ + + ### 图表 + + • `可选` **graph**: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> + + ####继承自 + + IPluginBaseConfig.graph + + #### 定义于 + + [types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7) + + ___ + + ### 隐藏边缘 + + • `可选` **hideEdge**:`布尔值` + + #### 定义于 + + [stdlib/plugin/minimap/index.ts:25](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L25) + + ___ + + ### 模式 + + • `可选` **模式**:``"keyShape"`` \| ``“默认”`` \| ``“代表”`` + + #### 定义于 + + [stdlib/plugin/minimap/index.ts:20](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L20) + + ___ + + ### 填充 + + • `可选` **填充**:`数字` + + #### 定义于 + + [stdlib/plugin/minimap/index.ts:24](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L24) + + ___ + + ### 刷新 + + • `可选` **刷新**:`布尔值` + + #### 定义于 + + [stdlib/plugin/minimap/index.ts:23](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L23) + + ___ + + ### 尺寸 + + • `可选` **尺寸**:`数量`[] + + #### 定义于 + + [stdlib/plugin/minimap/index.ts:21](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L21) + + ___ + + ### 视口类名 + + • `可选` **viewportClassName**:`string` + + #### 定义于 + + [stdlib/plugin/minimap/index.ts:18](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L18) \ No newline at end of file diff --git a/packages/site/docs/apis/interfaces/plugins-ToolbarConfig.md b/packages/site/docs/apis/interfaces/plugins-ToolbarConfig.en.md similarity index 58% rename from packages/site/docs/apis/interfaces/plugins-ToolbarConfig.md rename to packages/site/docs/apis/interfaces/plugins-ToolbarConfig.en.md index 8c600f2e80..857ccc2360 100644 --- a/packages/site/docs/apis/interfaces/plugins-ToolbarConfig.md +++ b/packages/site/docs/apis/interfaces/plugins-ToolbarConfig.en.md @@ -1,8 +1,8 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [plugins](../modules/plugins.md) / ToolbarConfig +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [plugins](../modules/plugins.en.md) / ToolbarConfig # Interface: ToolbarConfig -[plugins](../modules/plugins.md).ToolbarConfig +[plugins](../modules/plugins.en.md).ToolbarConfig ## Hierarchy @@ -22,7 +22,7 @@ IPluginBaseConfig.className #### Defined in -[types/plugin.ts:6](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/plugin.ts#L6) +[types/plugin.ts:6](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L6) ___ @@ -36,13 +36,13 @@ IPluginBaseConfig.container #### Defined in -[types/plugin.ts:5](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/plugin.ts#L5) +[types/plugin.ts:5](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L5) ___ ### getContent -• **getContent**: (`graph?`: [`IGraph`](types-IGraph.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `string` \| `HTMLDivElement` +• **getContent**: (`graph?`: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `string` \| `HTMLDivElement` #### Type declaration @@ -52,7 +52,7 @@ ___ | Name | Type | | :------ | :------ | -| `graph?` | [`IGraph`](types-IGraph.md)<`BehaviorRegistry`, `ThemeRegistry`\> | +| `graph?` | [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\> | ##### Returns @@ -60,13 +60,13 @@ ___ #### Defined in -[stdlib/plugin/toolbar/index.ts:14](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/toolbar/index.ts#L14) +[stdlib/plugin/toolbar/index.ts:14](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L14) ___ ### graph -• `Optional` **graph**: [`IGraph`](types-IGraph.md)<`BehaviorRegistry`, `ThemeRegistry`\> +• `Optional` **graph**: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\> #### Inherited from @@ -74,13 +74,13 @@ IPluginBaseConfig.graph #### Defined in -[types/plugin.ts:7](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/plugin.ts#L7) +[types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7) ___ ### handleClick -• `Optional` **handleClick**: (`code`: `string`, `graph`: [`IGraph`](types-IGraph.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `void` +• `Optional` **handleClick**: (`code`: `string`, `graph`: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `void` #### Type declaration @@ -93,7 +93,7 @@ toolbar config | Name | Type | Description | | :------ | :------ | :------ | | `code` | `string` | toolbar item code | -| `graph` | [`IGraph`](types-IGraph.md)<`BehaviorRegistry`, `ThemeRegistry`\> | Graph Instance | +| `graph` | [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\> | Graph Instance | ##### Returns @@ -101,7 +101,7 @@ toolbar config #### Defined in -[stdlib/plugin/toolbar/index.ts:13](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/toolbar/index.ts#L13) +[stdlib/plugin/toolbar/index.ts:13](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L13) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -[stdlib/plugin/toolbar/index.ts:17](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/toolbar/index.ts#L17) +[stdlib/plugin/toolbar/index.ts:17](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L17) ___ @@ -121,7 +121,7 @@ ___ #### Defined in -[stdlib/plugin/toolbar/index.ts:16](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/toolbar/index.ts#L16) +[stdlib/plugin/toolbar/index.ts:16](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L16) ___ @@ -131,4 +131,4 @@ ___ #### Defined in -[stdlib/plugin/toolbar/index.ts:15](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/toolbar/index.ts#L15) +[stdlib/plugin/toolbar/index.ts:15](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L15) diff --git a/packages/site/docs/apis/interfaces/plugins-ToolbarConfig.zh.md b/packages/site/docs/apis/interfaces/plugins-ToolbarConfig.zh.md new file mode 100644 index 0000000000..721fdfc33d --- /dev/null +++ b/packages/site/docs/apis/interfaces/plugins-ToolbarConfig.zh.md @@ -0,0 +1,134 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [插件](../modules/plugins.zh.md ) / 工具栏配置 + + # 接口:工具栏配置 + + [插件](../modules/plugins.zh.md).ToolbarConfig + + ## 等级制度 + + - `IPluginBaseConfig` + + ↳ **`工具栏配置`** + + ## 特性 + + ### 班级名称 + + • `可选` **类名**:`字符串` + + ####继承自 + + IPluginBaseConfig.className + + #### 定义于 + + [types/plugin.ts:6](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L6) + + ___ + + ### 容器 + + • `可选` **容器**:`字符串` \| `HTMLDivElement` + + ####继承自 + + IPluginBaseConfig.container + + #### 定义于 + + [types/plugin.ts:5](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L5) + + ___ + + ### 获取内容 + + • **getContent**: (`graph?`: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `string` \| `HTMLDivElement` + + #### 类型声明 + + ▸ (`图?`): `字符串` \| `HTMLDivElement` + + ##### 参数 + + | 名称 | 类型 | + | :------ | :------ | + | `图?` | [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> | + + ##### 返回 + + `字符串` \| `HTMLDivElement` + + #### 定义于 + + [stdlib/plugin/toolbar/index.ts:14](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L14) + + ___ + + ### 图表 + + • `可选` **graph**: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> + + ####继承自 + + IPluginBaseConfig.graph + + #### 定义于 + + [types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7) + + ___ + + ### 处理点击 + + • `可选` **handleClick**: (`code`: `string`, `graph`: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `无效` + + #### 类型声明 + + ▸ (`代码`, `图表`): `void` + + 工具栏配置 + + ##### 参数 + + | 名称 | 类型 | 描述 | + | :------ | :------ | :------ | + | `代码` | `字符串` | 工具栏项目代码| + | `图` | [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> | 图实例| + + ##### 返回 + + `无效` + + #### 定义于 + + [stdlib/plugin/toolbar/index.ts:13](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L13) + + ___ + + ### 最大缩放 + + • **maxZoom**:`数量` + + #### 定义于 + + [stdlib/plugin/toolbar/index.ts:17](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L17) + + ___ + + ### 最小缩放 + + • **minZoom**:`数字` + + #### 定义于 + + [stdlib/plugin/toolbar/index.ts:16](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L16) + + ___ + + ### 缩放灵敏度 + + • **缩放灵敏度**:`数字` + + #### 定义于 + + [stdlib/plugin/toolbar/index.ts:15](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L15) \ No newline at end of file diff --git a/packages/site/docs/apis/interfaces/plugins-TooltipConfig.md b/packages/site/docs/apis/interfaces/plugins-TooltipConfig.en.md similarity index 65% rename from packages/site/docs/apis/interfaces/plugins-TooltipConfig.md rename to packages/site/docs/apis/interfaces/plugins-TooltipConfig.en.md index d6c8daedab..d1a584c226 100644 --- a/packages/site/docs/apis/interfaces/plugins-TooltipConfig.md +++ b/packages/site/docs/apis/interfaces/plugins-TooltipConfig.en.md @@ -1,8 +1,8 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [plugins](../modules/plugins.md) / TooltipConfig +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [plugins](../modules/plugins.en.md) / TooltipConfig # Interface: TooltipConfig -[plugins](../modules/plugins.md).TooltipConfig +[plugins](../modules/plugins.en.md).TooltipConfig ## Hierarchy @@ -22,7 +22,7 @@ IPluginBaseConfig.className #### Defined in -[types/plugin.ts:6](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/plugin.ts#L6) +[types/plugin.ts:6](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L6) ___ @@ -36,7 +36,7 @@ IPluginBaseConfig.container #### Defined in -[types/plugin.ts:5](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/plugin.ts#L5) +[types/plugin.ts:5](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L5) ___ @@ -46,13 +46,13 @@ ___ #### Defined in -[stdlib/plugin/tooltip/index.ts:66](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/tooltip/index.ts#L66) +[stdlib/plugin/tooltip/index.ts:66](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L66) ___ ### getContent -• `Optional` **getContent**: (`evt?`: [`IG6GraphEvent`](types-IG6GraphEvent.md)) => `string` \| `HTMLDivElement` \| `Promise`<`string` \| `HTMLDivElement`\> +• `Optional` **getContent**: (`evt?`: [`IG6GraphEvent`](types-IG6GraphEvent.en.md)) => `string` \| `HTMLDivElement` \| `Promise`<`string` \| `HTMLDivElement`\> #### Type declaration @@ -62,7 +62,7 @@ ___ | Name | Type | | :------ | :------ | -| `evt?` | [`IG6GraphEvent`](types-IG6GraphEvent.md) | +| `evt?` | [`IG6GraphEvent`](types-IG6GraphEvent.en.md) | ##### Returns @@ -70,13 +70,13 @@ ___ #### Defined in -[stdlib/plugin/tooltip/index.ts:57](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/tooltip/index.ts#L57) +[stdlib/plugin/tooltip/index.ts:57](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L57) ___ ### graph -• `Optional` **graph**: [`IGraph`](types-IGraph.md)<`BehaviorRegistry`, `ThemeRegistry`\> +• `Optional` **graph**: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\> #### Inherited from @@ -84,7 +84,7 @@ IPluginBaseConfig.graph #### Defined in -[types/plugin.ts:7](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/plugin.ts#L7) +[types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[stdlib/plugin/tooltip/index.ts:64](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/tooltip/index.ts#L64) +[stdlib/plugin/tooltip/index.ts:64](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L64) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[stdlib/plugin/tooltip/index.ts:67](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/tooltip/index.ts#L67) +[stdlib/plugin/tooltip/index.ts:67](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L67) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[stdlib/plugin/tooltip/index.ts:60](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/tooltip/index.ts#L60) +[stdlib/plugin/tooltip/index.ts:60](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L60) ___ @@ -124,13 +124,13 @@ ___ #### Defined in -[stdlib/plugin/tooltip/index.ts:61](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/tooltip/index.ts#L61) +[stdlib/plugin/tooltip/index.ts:61](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L61) ___ ### shouldBegin -• `Optional` **shouldBegin**: (`evt?`: [`IG6GraphEvent`](types-IG6GraphEvent.md)) => `boolean` +• `Optional` **shouldBegin**: (`evt?`: [`IG6GraphEvent`](types-IG6GraphEvent.en.md)) => `boolean` #### Type declaration @@ -140,7 +140,7 @@ ___ | Name | Type | | :------ | :------ | -| `evt?` | [`IG6GraphEvent`](types-IG6GraphEvent.md) | +| `evt?` | [`IG6GraphEvent`](types-IG6GraphEvent.en.md) | ##### Returns @@ -148,7 +148,7 @@ ___ #### Defined in -[stdlib/plugin/tooltip/index.ts:62](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/tooltip/index.ts#L62) +[stdlib/plugin/tooltip/index.ts:62](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L62) ___ @@ -158,4 +158,4 @@ ___ #### Defined in -[stdlib/plugin/tooltip/index.ts:65](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/stdlib/plugin/tooltip/index.ts#L65) +[stdlib/plugin/tooltip/index.ts:65](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L65) diff --git a/packages/site/docs/apis/interfaces/plugins-TooltipConfig.zh.md b/packages/site/docs/apis/interfaces/plugins-TooltipConfig.zh.md new file mode 100644 index 0000000000..c9fa42499e --- /dev/null +++ b/packages/site/docs/apis/interfaces/plugins-TooltipConfig.zh.md @@ -0,0 +1,161 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [插件](../modules/plugins.zh.md ) / 工具提示配置 + + # 接口:TooltipConfig + + [插件](../modules/plugins.zh.md).TooltipConfig + + ## 等级制度 + + - `IPluginBaseConfig` + + ↳ **`工具提示配置`** + + ## 特性 + + ### 班级名称 + + • `可选` **类名**:`字符串` + + ####继承自 + + IPluginBaseConfig.className + + #### 定义于 + + [types/plugin.ts:6](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L6) + + ___ + + ### 容器 + + • `可选` **容器**:`字符串` \| `HTMLDivElement` + + ####继承自 + + IPluginBaseConfig.container + + #### 定义于 + + [types/plugin.ts:5](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L5) + + ___ + + ### 修复到节点 + + • `可选` **fixToNode**: [`number`, `number`] \| `放置` + + #### 定义于 + + [stdlib/plugin/tooltip/index.ts:66](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L66) + + ___ + + ### 获取内容 + + • `可选` **getContent**: (`evt?`: [`IG6GraphEvent`](types-IG6GraphEvent.zh.md)) => `string` \| `HTMLDivElement` \| `Promise`<`字符串` \| `HTMLDivElement`\> + + #### 类型声明 + + ▸ (`evt?`): `字符串` \| `HTMLDivElement` \| `Promise`<`字符串` \| `HTMLDivElement`\> + + ##### 参数 + + | 名称 | 类型 | + | :------ | :------ | + | `事件?` | [`IG6GraphEvent`](types-IG6GraphEvent.zh.md) | + + ##### 返回 + + `字符串` \| `HTMLDivElement` \| `Promise`<`字符串` \| `HTMLDivElement`\> + + #### 定义于 + + [stdlib/plugin/tooltip/index.ts:57](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L57) + + ___ + + ### 图表 + + • `可选` **graph**: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> + + ####继承自 + + IPluginBaseConfig.graph + + #### 定义于 + + [types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7) + + ___ + + ### 项目类型 + + • `可选` **itemTypes**: (``"node"`` \| ``"edge"`` \| ``"combo"`` \| ``"canvas"``)[] + + #### 定义于 + + [stdlib/plugin/tooltip/index.ts:64](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L64) + + ___ + + ### 加载内容 + + • `可选` **loadingContent**:`字符串` \| `HTMLDivElement` + + #### 定义于 + + [stdlib/plugin/tooltip/index.ts:67](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L67) + + ___ + + ### 偏移X + + • `可选` **offsetX**:`数字` + + #### 定义于 + + [stdlib/plugin/tooltip/index.ts:60](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L60) + + ___ + + ### 偏移Y + + • `可选` **offsetY**:`数字` + + #### 定义于 + + [stdlib/plugin/tooltip/index.ts:61](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L61) + + ___ + + ### 应该开始 + + • `可选` **shouldBegin**: (`evt?`: [`IG6GraphEvent`](types-IG6GraphEvent.zh.md)) => `boolean` + + #### 类型声明 + + ▸ (`evt?`): `布尔值` + + ##### 参数 + + | 名称 | 类型 | + | :------ | :------ | + | `事件?` | [`IG6GraphEvent`](types-IG6GraphEvent.zh.md) | + + ##### 返回 + + `布尔值` + + #### 定义于 + + [stdlib/plugin/tooltip/index.ts:62](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L62) + + ___ + + ### 扳机 + + • `可选` **触发**:``"点击"`` \| ``“指针输入器”`` + + #### 定义于 + + [stdlib/plugin/tooltip/index.ts:65](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L65) \ No newline at end of file diff --git a/packages/site/docs/apis/interfaces/types-GraphData.en.md b/packages/site/docs/apis/interfaces/types-GraphData.en.md new file mode 100644 index 0000000000..a56176e349 --- /dev/null +++ b/packages/site/docs/apis/interfaces/types-GraphData.en.md @@ -0,0 +1,35 @@ +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [types](../modules/types.en.md) / GraphData + +# Interface: GraphData + +[types](../modules/types.en.md).GraphData + +## Properties + +### combos + +• `Optional` **combos**: [`ComboUserModel`](../modules/types.en.md#combousermodel)[] + +#### Defined in + +[types/data.ts:14](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/data.ts#L14) + +___ + +### edges + +• `Optional` **edges**: [`EdgeUserModel`](../modules/types.en.md#edgeusermodel)[] + +#### Defined in + +[types/data.ts:13](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/data.ts#L13) + +___ + +### nodes + +• `Optional` **nodes**: [`NodeUserModel`](../modules/types.en.md#nodeusermodel)[] + +#### Defined in + +[types/data.ts:12](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/data.ts#L12) diff --git a/packages/site/docs/apis/interfaces/types-GraphData.md b/packages/site/docs/apis/interfaces/types-GraphData.md deleted file mode 100644 index 25c21dbc4a..0000000000 --- a/packages/site/docs/apis/interfaces/types-GraphData.md +++ /dev/null @@ -1,35 +0,0 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / GraphData - -# Interface: GraphData - -[types](../modules/types.md).GraphData - -## Properties - -### combos - -• `Optional` **combos**: [`ComboUserModel`](../modules/types.md#combousermodel)[] - -#### Defined in - -[types/data.ts:14](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/data.ts#L14) - -___ - -### edges - -• `Optional` **edges**: [`EdgeUserModel`](../modules/types.md#edgeusermodel)[] - -#### Defined in - -[types/data.ts:13](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/data.ts#L13) - -___ - -### nodes - -• `Optional` **nodes**: [`NodeUserModel`](../modules/types.md#nodeusermodel)[] - -#### Defined in - -[types/data.ts:12](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/data.ts#L12) diff --git a/packages/site/docs/apis/interfaces/types-GraphData.zh.md b/packages/site/docs/apis/interfaces/types-GraphData.zh.md new file mode 100644 index 0000000000..03795dffce --- /dev/null +++ b/packages/site/docs/apis/interfaces/types-GraphData.zh.md @@ -0,0 +1,35 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [类型](../modules/types.zh.md ) / 图数据 + + # 接口:图数据 + + [类型](../modules/types.zh.md).GraphData + + ## 特性 + + ###连击 + + • `可选` **组合**:[`ComboUserModel`](../modules/types.zh.md#combousermodel)[] + + #### 定义于 + + [类型/data.ts:14](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/data.ts#L14) + + ___ + + ### 边缘 + + • `可选` **边缘**:[`EdgeUserModel`](../modules/types.zh.md#edgeusermodel)[] + + #### 定义于 + + [类型/data.ts:13](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/data.ts#L13) + + ___ + + ### 节点 + + • `可选` **节点**:[`NodeUserModel`](../modules/types.zh.md#nodeusermodel)[] + + #### 定义于 + + [类型/data.ts:12](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/data.ts#L12) \ No newline at end of file diff --git a/packages/site/docs/apis/interfaces/types-IG6GraphEvent.md b/packages/site/docs/apis/interfaces/types-IG6GraphEvent.en.md similarity index 53% rename from packages/site/docs/apis/interfaces/types-IG6GraphEvent.md rename to packages/site/docs/apis/interfaces/types-IG6GraphEvent.en.md index ba6ee1299e..a0ebc26819 100644 --- a/packages/site/docs/apis/interfaces/types-IG6GraphEvent.md +++ b/packages/site/docs/apis/interfaces/types-IG6GraphEvent.en.md @@ -1,8 +1,8 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / IG6GraphEvent +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [types](../modules/types.en.md) / IG6GraphEvent # Interface: IG6GraphEvent -[types](../modules/types.md).IG6GraphEvent +[types](../modules/types.en.md).IG6GraphEvent ## Hierarchy @@ -14,11 +14,11 @@ ### currentTarget -• **currentTarget**: [`IGraph`](types-IGraph.md)<`BehaviorRegistry`, `ThemeRegistry`\> +• **currentTarget**: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\> #### Defined in -[types/event.ts:42](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/event.ts#L42) +[types/event.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L42) ___ @@ -30,7 +30,7 @@ Original event emitted by G #### Defined in -[types/event.ts:46](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/event.ts#L46) +[types/event.ts:46](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L46) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[types/event.ts:44](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/event.ts#L44) +[types/event.ts:44](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L44) ___ @@ -50,4 +50,4 @@ ___ #### Defined in -[types/event.ts:43](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/event.ts#L43) +[types/event.ts:43](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L43) diff --git a/packages/site/docs/apis/interfaces/types-IG6GraphEvent.zh.md b/packages/site/docs/apis/interfaces/types-IG6GraphEvent.zh.md new file mode 100644 index 0000000000..f9a244eb0c --- /dev/null +++ b/packages/site/docs/apis/interfaces/types-IG6GraphEvent.zh.md @@ -0,0 +1,53 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [类型](../modules/types.zh.md ) / IG6GraphEvent + + # 接口:IG6GraphEvent + + [类型](../modules/types.zh.md).IG6GraphEvent + + ## 等级制度 + + - `省略`<`FederatedPointerEvent`, ``"currentTarget"``\> + + ↳ **`IG6GraphEvent`** + + ## 特性 + + ### 当前目标 + + • **currentTarget**: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> + + #### 定义于 + + [类型/event.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L42) + + ___ + + ### gEvent + + • **gEvent**:`事件` + + G 发出的原始事件 + + #### 定义于 + + [类型/event.ts:46](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L46) + + ___ + + ### 商品编号 + + • **itemId**:`ID` + + #### 定义于 + + [类型/event.ts:44](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L44) + + ___ + + ### 物品种类 + + • **itemType**:``“节点”`` \| ``“边缘”`` \| ``“组合”`` \| ``“画布”`` + + #### 定义于 + + [类型/event.ts:43](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L43) \ No newline at end of file diff --git a/packages/site/docs/apis/interfaces/types-IGraph.md b/packages/site/docs/apis/interfaces/types-IGraph.en.md similarity index 64% rename from packages/site/docs/apis/interfaces/types-IGraph.md rename to packages/site/docs/apis/interfaces/types-IGraph.en.md index a66d99090a..f7b86607e1 100644 --- a/packages/site/docs/apis/interfaces/types-IGraph.md +++ b/packages/site/docs/apis/interfaces/types-IGraph.en.md @@ -1,8 +1,8 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / IGraph +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [types](../modules/types.en.md) / IGraph # Interface: IGraph -[types](../modules/types.md).IGraph +[types](../modules/types.en.md).IGraph ## Type parameters @@ -19,7 +19,7 @@ ## Implemented by -- [`Graph`](../classes/graph-Graph.md) +- [`Graph`](../classes/graph-Graph.en.md) ## Indexable @@ -29,11 +29,11 @@ ### addCombo -• **addCombo**: (`model`: [`ComboUserModel`](../modules/types.md#combousermodel), `childrenIds`: `ID`[], `stack?`: `boolean`) => [`ComboModel`](../modules/types.md#combomodel) +• **addCombo**: (`model`: [`ComboUserModel`](../modules/types.en.md#combousermodel), `childrenIds`: `ID`[], `stack?`: `boolean`) => [`ComboModel`](../modules/types.en.md#combomodel) #### Type declaration -▸ (`model`, `childrenIds`, `stack?`): [`ComboModel`](../modules/types.md#combomodel) +▸ (`model`, `childrenIds`, `stack?`): [`ComboModel`](../modules/types.en.md#combomodel) Add a new combo to the graph, and update the structure of the existed child in childrenIds to be the children of the new combo. Different from addData with combo type, this API update the succeeds' combo tree strucutres in the same time. @@ -42,19 +42,19 @@ Different from addData with combo type, this API update the succeeds' combo tree | Name | Type | Description | | :------ | :------ | :------ | -| `model` | [`ComboUserModel`](../modules/types.md#combousermodel) | combo user data | +| `model` | [`ComboUserModel`](../modules/types.en.md#combousermodel) | combo user data | | `childrenIds` | `ID`[] | - | | `stack?` | `boolean` | whether push this operation to stack | ##### Returns -[`ComboModel`](../modules/types.md#combomodel) +[`ComboModel`](../modules/types.en.md#combomodel) whether success #### Defined in -[types/graph.ts:554](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L554) +[types/graph.ts:554](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L554) ___ @@ -81,7 +81,7 @@ Collapse a combo. #### Defined in -[types/graph.ts:564](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L564) +[types/graph.ts:564](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L564) ___ @@ -108,17 +108,17 @@ Expand a combo. #### Defined in -[types/graph.ts:571](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L571) +[types/graph.ts:571](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L571) ## Data ### addData -• **addData**: (`itemType`: `ITEM_TYPE`, `model`: [`EdgeUserModel`](../modules/types.md#edgeusermodel) \| [`NodeUserModel`](../modules/types.md#nodeusermodel) \| [`ComboUserModel`](../modules/types.md#combousermodel) \| [`NodeUserModel`](../modules/types.md#nodeusermodel)[] \| [`EdgeUserModel`](../modules/types.md#edgeusermodel)[] \| [`ComboUserModel`](../modules/types.md#combousermodel)[], `stack?`: `boolean`) => [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +• **addData**: (`itemType`: `ITEM_TYPE`, `model`: [`EdgeUserModel`](../modules/types.en.md#edgeusermodel) \| [`NodeUserModel`](../modules/types.en.md#nodeusermodel) \| [`ComboUserModel`](../modules/types.en.md#combousermodel) \| [`NodeUserModel`](../modules/types.en.md#nodeusermodel)[] \| [`EdgeUserModel`](../modules/types.en.md#edgeusermodel)[] \| [`ComboUserModel`](../modules/types.en.md#combousermodel)[], `stack?`: `boolean`) => [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] #### Type declaration -▸ (`itemType`, `model`, `stack?`): [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +▸ (`itemType`, `model`, `stack?`): [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] Add one or more node/edge/combo data to the graph. @@ -127,24 +127,24 @@ Add one or more node/edge/combo data to the graph. | Name | Type | Description | | :------ | :------ | :------ | | `itemType` | `ITEM_TYPE` | item type | -| `model` | [`EdgeUserModel`](../modules/types.md#edgeusermodel) \| [`NodeUserModel`](../modules/types.md#nodeusermodel) \| [`ComboUserModel`](../modules/types.md#combousermodel) \| [`NodeUserModel`](../modules/types.md#nodeusermodel)[] \| [`EdgeUserModel`](../modules/types.md#edgeusermodel)[] \| [`ComboUserModel`](../modules/types.md#combousermodel)[] | user data | +| `model` | [`EdgeUserModel`](../modules/types.en.md#edgeusermodel) \| [`NodeUserModel`](../modules/types.en.md#nodeusermodel) \| [`ComboUserModel`](../modules/types.en.md#combousermodel) \| [`NodeUserModel`](../modules/types.en.md#nodeusermodel)[] \| [`EdgeUserModel`](../modules/types.en.md#edgeusermodel)[] \| [`ComboUserModel`](../modules/types.en.md#combousermodel)[] | user data | | `stack?` | `boolean` | whether push this operation to stack | ##### Returns -[`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +[`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] whehter success #### Defined in -[types/graph.ts:177](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L177) +[types/graph.ts:177](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L177) ___ ### changeData -• **changeData**: (`data`: [`GraphData`](types-GraphData.md), `type`: ``"replace"`` \| ``"mergeReplace"``) => `void` +• **changeData**: (`data`: [`GraphData`](types-GraphData.en.md), `type`: ``"replace"`` \| ``"mergeReplace"``) => `void` #### Type declaration @@ -156,7 +156,7 @@ Change graph data. | Name | Type | Description | | :------ | :------ | :------ | -| `data` | [`GraphData`](types-GraphData.md) | new data | +| `data` | [`GraphData`](types-GraphData.en.md) | new data | | `type` | ``"replace"`` \| ``"mergeReplace"`` | the way to change data, 'replace' means discard the old data and use the new one; 'mergeReplace' means merge the common part, remove (old - new), add (new - old) | ##### Returns @@ -165,83 +165,83 @@ Change graph data. #### Defined in -[types/graph.ts:148](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L148) +[types/graph.ts:148](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L148) ___ ### getAllCombosData -• **getAllCombosData**: () => [`ComboModel`](../modules/types.md#combomodel)[] +• **getAllCombosData**: () => [`ComboModel`](../modules/types.en.md#combomodel)[] #### Type declaration -▸ (): [`ComboModel`](../modules/types.md#combomodel)[] +▸ (): [`ComboModel`](../modules/types.en.md#combomodel)[] Get all the combos' inner data ##### Returns -[`ComboModel`](../modules/types.md#combomodel)[] +[`ComboModel`](../modules/types.en.md#combomodel)[] all combos' inner data on the graph #### Defined in -[types/graph.ts:99](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L99) +[types/graph.ts:99](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L99) ___ ### getAllEdgesData -• **getAllEdgesData**: () => [`EdgeModel`](../modules/types.md#edgemodel)[] +• **getAllEdgesData**: () => [`EdgeModel`](../modules/types.en.md#edgemodel)[] #### Type declaration -▸ (): [`EdgeModel`](../modules/types.md#edgemodel)[] +▸ (): [`EdgeModel`](../modules/types.en.md#edgemodel)[] Get all the edges' inner data ##### Returns -[`EdgeModel`](../modules/types.md#edgemodel)[] +[`EdgeModel`](../modules/types.en.md#edgemodel)[] all edges' inner data on the graph #### Defined in -[types/graph.ts:93](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L93) +[types/graph.ts:93](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L93) ___ ### getAllNodesData -• **getAllNodesData**: () => [`NodeModel`](../modules/types.md#nodemodel)[] +• **getAllNodesData**: () => [`NodeModel`](../modules/types.en.md#nodemodel)[] #### Type declaration -▸ (): [`NodeModel`](../modules/types.md#nodemodel)[] +▸ (): [`NodeModel`](../modules/types.en.md#nodemodel)[] Get all the nodes' inner data ##### Returns -[`NodeModel`](../modules/types.md#nodemodel)[] +[`NodeModel`](../modules/types.en.md#nodemodel)[] all nodes' inner data on the graph #### Defined in -[types/graph.ts:87](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L87) +[types/graph.ts:87](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L87) ___ ### getComboData -• **getComboData**: (`condition`: `Function` \| `ID`) => [`ComboModel`](../modules/types.md#combomodel) +• **getComboData**: (`condition`: `Function` \| `ID`) => [`ComboModel`](../modules/types.en.md#combomodel) #### Type declaration -▸ (`condition`): [`ComboModel`](../modules/types.md#combomodel) +▸ (`condition`): [`ComboModel`](../modules/types.en.md#combomodel) Find a combo's inner data according to id or function. @@ -253,23 +253,23 @@ Find a combo's inner data according to id or function. ##### Returns -[`ComboModel`](../modules/types.md#combomodel) +[`ComboModel`](../modules/types.en.md#combomodel) result combo's inner data #### Defined in -[types/graph.ts:81](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L81) +[types/graph.ts:81](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L81) ___ ### getEdgeData -• **getEdgeData**: (`condition`: `Function` \| `ID`) => [`EdgeModel`](../modules/types.md#edgemodel) +• **getEdgeData**: (`condition`: `Function` \| `ID`) => [`EdgeModel`](../modules/types.en.md#edgemodel) #### Type declaration -▸ (`condition`): [`EdgeModel`](../modules/types.md#edgemodel) +▸ (`condition`): [`EdgeModel`](../modules/types.en.md#edgemodel) Find an edge's inner data according to id or function. @@ -281,23 +281,23 @@ Find an edge's inner data according to id or function. ##### Returns -[`EdgeModel`](../modules/types.md#edgemodel) +[`EdgeModel`](../modules/types.en.md#edgemodel) result edge's inner data #### Defined in -[types/graph.ts:74](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L74) +[types/graph.ts:74](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L74) ___ ### getNeighborNodesData -• **getNeighborNodesData**: (`nodeId`: `ID`, `direction?`: ``"both"`` \| ``"in"`` \| ``"out"``) => [`NodeModel`](../modules/types.md#nodemodel)[] +• **getNeighborNodesData**: (`nodeId`: `ID`, `direction?`: ``"both"`` \| ``"in"`` \| ``"out"``) => [`NodeModel`](../modules/types.en.md#nodemodel)[] #### Type declaration -▸ (`nodeId`, `direction?`): [`NodeModel`](../modules/types.md#nodemodel)[] +▸ (`nodeId`, `direction?`): [`NodeModel`](../modules/types.en.md#nodemodel)[] Get one-hop node ids from a start node. @@ -310,23 +310,23 @@ Get one-hop node ids from a start node. ##### Returns -[`NodeModel`](../modules/types.md#nodemodel)[] +[`NodeModel`](../modules/types.en.md#nodemodel)[] one-hop node ids #### Defined in -[types/graph.ts:116](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L116) +[types/graph.ts:116](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L116) ___ ### getNodeData -• **getNodeData**: (`condition`: `Function` \| `ID`) => [`NodeModel`](../modules/types.md#nodemodel) +• **getNodeData**: (`condition`: `Function` \| `ID`) => [`NodeModel`](../modules/types.en.md#nodemodel) #### Type declaration -▸ (`condition`): [`NodeModel`](../modules/types.md#nodemodel) +▸ (`condition`): [`NodeModel`](../modules/types.en.md#nodemodel) Find a node's inner data according to id or function. @@ -338,23 +338,23 @@ Find a node's inner data according to id or function. ##### Returns -[`NodeModel`](../modules/types.md#nodemodel) +[`NodeModel`](../modules/types.en.md#nodemodel) result node's inner data #### Defined in -[types/graph.ts:67](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L67) +[types/graph.ts:67](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L67) ___ ### getRelatedEdgesData -• **getRelatedEdgesData**: (`nodeId`: `ID`, `direction?`: ``"both"`` \| ``"in"`` \| ``"out"``) => [`EdgeModel`](../modules/types.md#edgemodel)[] +• **getRelatedEdgesData**: (`nodeId`: `ID`, `direction?`: ``"both"`` \| ``"in"`` \| ``"out"``) => [`EdgeModel`](../modules/types.en.md#edgemodel)[] #### Type declaration -▸ (`nodeId`, `direction?`): [`EdgeModel`](../modules/types.md#edgemodel)[] +▸ (`nodeId`, `direction?`): [`EdgeModel`](../modules/types.en.md#edgemodel)[] Get one-hop edge ids from a start node. @@ -367,23 +367,23 @@ Get one-hop edge ids from a start node. ##### Returns -[`EdgeModel`](../modules/types.md#edgemodel)[] +[`EdgeModel`](../modules/types.en.md#edgemodel)[] one-hop edge ids #### Defined in -[types/graph.ts:106](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L106) +[types/graph.ts:106](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L106) ___ ### moveCombo -• **moveCombo**: (`ids`: `ID`[], `dx`: `number`, `dy`: `number`, `upsertAncestors?`: `boolean`, `callback?`: (`model`: [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel), `canceled?`: `boolean`) => `void`, `stack?`: `boolean`) => [`ComboModel`](../modules/types.md#combomodel)[] +• **moveCombo**: (`ids`: `ID`[], `dx`: `number`, `dy`: `number`, `upsertAncestors?`: `boolean`, `callback?`: (`model`: [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel), `canceled?`: `boolean`) => `void`, `stack?`: `boolean`) => [`ComboModel`](../modules/types.en.md#combomodel)[] #### Type declaration -▸ (`ids`, `dx`, `dy`, `upsertAncestors?`, `callback?`, `stack?`): [`ComboModel`](../modules/types.md#combomodel)[] +▸ (`ids`, `dx`, `dy`, `upsertAncestors?`, `callback?`, `stack?`): [`ComboModel`](../modules/types.en.md#combomodel)[] Move one or more combos a distance (dx, dy) relatively, do not update other styles which leads to better performance than updating positions by updateData. @@ -397,22 +397,22 @@ In fact, it changes the succeed nodes positions to affect the combo's position, | `dx` | `number` | - | | `dy` | `number` | - | | `upsertAncestors?` | `boolean` | - | -| `callback?` | (`model`: [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel), `canceled?`: `boolean`) => `void` | - | +| `callback?` | (`model`: [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel), `canceled?`: `boolean`) => `void` | - | | `stack?` | `boolean` | whether push this operation into graph's stack, true by default | ##### Returns -[`ComboModel`](../modules/types.md#combomodel)[] +[`ComboModel`](../modules/types.en.md#combomodel)[] #### Defined in -[types/graph.ts:278](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L278) +[types/graph.ts:278](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L278) ___ ### read -• **read**: (`data`: [`GraphData`](types-GraphData.md)) => `void` +• **read**: (`data`: [`GraphData`](types-GraphData.en.md)) => `void` #### Type declaration @@ -425,7 +425,7 @@ If there is old data, diffs and changes it. | Name | Type | | :------ | :------ | -| `data` | [`GraphData`](types-GraphData.md) | +| `data` | [`GraphData`](types-GraphData.en.md) | ##### Returns @@ -433,7 +433,7 @@ If there is old data, diffs and changes it. #### Defined in -[types/graph.ts:140](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L140) +[types/graph.ts:140](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L140) ___ @@ -463,7 +463,7 @@ whehter success #### Defined in -[types/graph.ts:201](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L201) +[types/graph.ts:201](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L201) ___ @@ -490,17 +490,17 @@ Show the item(s). #### Defined in -[types/graph.ts:466](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L466) +[types/graph.ts:466](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L466) ___ ### updateComboPosition -• **updateComboPosition**: (`models`: `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel)\>[]\>, `upsertAncestors?`: `boolean`, `disableAnimate?`: `boolean`, `callback?`: (`model`: [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel)) => `void`, `stack?`: `boolean`) => [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +• **updateComboPosition**: (`models`: `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel)\>[]\>, `upsertAncestors?`: `boolean`, `disableAnimate?`: `boolean`, `callback?`: (`model`: [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel)) => `void`, `stack?`: `boolean`) => [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] #### Type declaration -▸ (`models`, `upsertAncestors?`, `disableAnimate?`, `callback?`, `stack?`): [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +▸ (`models`, `upsertAncestors?`, `disableAnimate?`, `callback?`, `stack?`): [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] Update one or more combos' positions, it is achieved by move the succeed nodes. Do not update other styles which leads to better performance than updating positions by updateData. @@ -509,29 +509,29 @@ Do not update other styles which leads to better performance than updating posit | Name | Type | Description | | :------ | :------ | :------ | -| `models` | `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel)\>[]\> | new configurations with x and y for every combo, which has id field to indicate the specific item | +| `models` | `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel)\>[]\> | new configurations with x and y for every combo, which has id field to indicate the specific item | | `upsertAncestors?` | `boolean` | - | | `disableAnimate?` | `boolean` | - | -| `callback?` | (`model`: [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel)) => `void` | - | +| `callback?` | (`model`: [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel)) => `void` | - | | `stack?` | `boolean` | whether push this operation into graph's stack, true by default | ##### Returns -[`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +[`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] #### Defined in -[types/graph.ts:258](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L258) +[types/graph.ts:258](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L258) ___ ### updateData -• **updateData**: (`itemType`: `ITEM_TYPE`, `model`: `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\> \| `Partial`<[`EdgeUserModel`](../modules/types.md#edgeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\>[] \| `Partial`<[`EdgeUserModel`](../modules/types.md#edgeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel)\>[]\>, `stack?`: `boolean`) => [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +• **updateData**: (`itemType`: `ITEM_TYPE`, `model`: `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\> \| `Partial`<[`EdgeUserModel`](../modules/types.en.md#edgeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\>[] \| `Partial`<[`EdgeUserModel`](../modules/types.en.md#edgeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel)\>[]\>, `stack?`: `boolean`) => [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] #### Type declaration -▸ (`itemType`, `model`, `stack?`): [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +▸ (`itemType`, `model`, `stack?`): [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] Update one or more node/edge/combo data on the graph. @@ -540,26 +540,26 @@ Update one or more node/edge/combo data on the graph. | Name | Type | Description | | :------ | :------ | :------ | | `itemType` | `ITEM_TYPE` | - | -| `model` | `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\> \| `Partial`<[`EdgeUserModel`](../modules/types.md#edgeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\>[] \| `Partial`<[`EdgeUserModel`](../modules/types.md#edgeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel)\>[]\> | update configs | +| `model` | `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\> \| `Partial`<[`EdgeUserModel`](../modules/types.en.md#edgeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\>[] \| `Partial`<[`EdgeUserModel`](../modules/types.en.md#edgeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel)\>[]\> | update configs | | `stack?` | `boolean` | whether push this operation to stack | ##### Returns -[`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`EdgeModel`](../modules/types.md#edgemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +[`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`EdgeModel`](../modules/types.en.md#edgemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] #### Defined in -[types/graph.ts:209](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L209) +[types/graph.ts:209](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L209) ___ ### updateNodePosition -• **updateNodePosition**: (`models`: `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel)\>[]\>, `upsertAncestors?`: `boolean`, `disableAnimate?`: `boolean`, `callback?`: (`model`: [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel), `canceled?`: `boolean`) => `void`, `stack?`: `boolean`) => [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +• **updateNodePosition**: (`models`: `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel)\>[]\>, `upsertAncestors?`: `boolean`, `disableAnimate?`: `boolean`, `callback?`: (`model`: [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel), `canceled?`: `boolean`) => `void`, `stack?`: `boolean`) => [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] #### Type declaration -▸ (`models`, `upsertAncestors?`, `disableAnimate?`, `callback?`, `stack?`): [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +▸ (`models`, `upsertAncestors?`, `disableAnimate?`, `callback?`, `stack?`): [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] Update one or more nodes' positions, do not update other styles which leads to better performance than updating positions by updateData. @@ -568,19 +568,19 @@ do not update other styles which leads to better performance than updating posit | Name | Type | Description | | :------ | :------ | :------ | -| `models` | `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.md#nodeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.md#combousermodel)\>[]\> | new configurations with x and y for every node, which has id field to indicate the specific item | +| `models` | `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\> \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel) \| `Partial`<[`NodeUserModel`](../modules/types.en.md#nodeusermodel)\>[] \| `Partial`<[`ComboUserModel`](../modules/types.en.md#combousermodel)\>[]\> | new configurations with x and y for every node, which has id field to indicate the specific item | | `upsertAncestors?` | `boolean` | - | | `disableAnimate?` | `boolean` | - | -| `callback?` | (`model`: [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel), `canceled?`: `boolean`) => `void` | - | +| `callback?` | (`model`: [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel), `canceled?`: `boolean`) => `void` | - | | `stack?` | `boolean` | whether push this operation into graph's stack, true by default | ##### Returns -[`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel) \| [`NodeModel`](../modules/types.md#nodemodel)[] \| [`ComboModel`](../modules/types.md#combomodel)[] +[`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel) \| [`NodeModel`](../modules/types.en.md#nodemodel)[] \| [`ComboModel`](../modules/types.en.md#combomodel)[] #### Defined in -[types/graph.ts:236](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L236) +[types/graph.ts:236](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L236) ## Graph Instance @@ -606,7 +606,7 @@ Destroy the graph instance and remove the related canvases. #### Defined in -[types/graph.ts:39](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L39) +[types/graph.ts:39](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L39) ## Interaction @@ -636,7 +636,7 @@ upserted shape or group #### Defined in -[types/graph.ts:622](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L622) +[types/graph.ts:622](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L622) ___ @@ -663,7 +663,7 @@ Remove behavior(s) from mode(s). #### Defined in -[types/graph.ts:605](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L605) +[types/graph.ts:605](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L605) ___ @@ -689,7 +689,7 @@ Switch mode. #### Defined in -[types/graph.ts:587](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L587) +[types/graph.ts:587](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L587) ___ @@ -716,7 +716,7 @@ Update a behavior on a mode. #### Defined in -[types/graph.ts:613](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L613) +[types/graph.ts:613](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L613) ## Item @@ -743,7 +743,7 @@ Make the item(s) to the back. #### Defined in -[types/graph.ts:487](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L487) +[types/graph.ts:487](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L487) ___ @@ -771,13 +771,13 @@ Clear all the states for item(s). #### Defined in -[types/graph.ts:524](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L524) +[types/graph.ts:524](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L524) ___ ### findIdByState -• **findIdByState**: (`itemType`: `ITEM_TYPE`, `state`: `string`, `value?`: `string` \| `boolean`, `additionalFilter?`: (`model`: [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel)) => `boolean`) => `ID`[] +• **findIdByState**: (`itemType`: `ITEM_TYPE`, `state`: `string`, `value?`: `string` \| `boolean`, `additionalFilter?`: (`model`: [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel)) => `boolean`) => `ID`[] #### Type declaration @@ -792,7 +792,7 @@ Find items which has the state. | `itemType` | `ITEM_TYPE` | item type | | `state` | `string` | state name | | `value?` | `string` \| `boolean` | state value, true by default | -| `additionalFilter?` | (`model`: [`EdgeModel`](../modules/types.md#edgemodel) \| [`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel)) => `boolean` | additional filter function | +| `additionalFilter?` | (`model`: [`EdgeModel`](../modules/types.en.md#edgemodel) \| [`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel)) => `boolean` | additional filter function | ##### Returns @@ -802,7 +802,7 @@ items that is the type and has the state #### Defined in -[types/graph.ts:163](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L163) +[types/graph.ts:163](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L163) ___ @@ -829,7 +829,7 @@ Make the item(s) to the front. #### Defined in -[types/graph.ts:480](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L480) +[types/graph.ts:480](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L480) ___ @@ -857,7 +857,7 @@ the state names with value true #### Defined in -[types/graph.ts:516](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L516) +[types/graph.ts:516](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L516) ___ @@ -886,7 +886,7 @@ the state value #### Defined in -[types/graph.ts:509](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L509) +[types/graph.ts:509](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L509) ___ @@ -913,7 +913,7 @@ Hide the item(s). #### Defined in -[types/graph.ts:473](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L473) +[types/graph.ts:473](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L473) ___ @@ -942,7 +942,7 @@ Set state for the item(s). #### Defined in -[types/graph.ts:496](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L496) +[types/graph.ts:496](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L496) ## Plugin @@ -968,7 +968,7 @@ Add plugin(s) to graph. #### Defined in -[types/graph.ts:634](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L634) +[types/graph.ts:634](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L634) ___ @@ -994,7 +994,7 @@ Remove plugin(s) from graph. #### Defined in -[types/graph.ts:648](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L648) +[types/graph.ts:648](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L648) ___ @@ -1022,7 +1022,7 @@ Update one plugin of the graph. #### Defined in -[types/graph.ts:656](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L656) +[types/graph.ts:656](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L656) ## Properties @@ -1049,7 +1049,7 @@ Add behavior(s) to mode(s). #### Defined in -[types/graph.ts:594](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L594) +[types/graph.ts:594](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L594) ___ @@ -1077,7 +1077,7 @@ more convenient way without manually invoking `startBatch` and `stopBatch`. #### Defined in -[types/graph.ts:746](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L746) +[types/graph.ts:746](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L746) ___ @@ -1097,7 +1097,7 @@ Indicate whether there are any actions available in the redo stack. #### Defined in -[types/graph.ts:724](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L724) +[types/graph.ts:724](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L724) ___ @@ -1117,7 +1117,7 @@ Indicate whether there are any actions available in the undo stack. #### Defined in -[types/graph.ts:719](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L719) +[types/graph.ts:719](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L719) ___ @@ -1127,7 +1127,7 @@ ___ #### Defined in -[types/graph.ts:27](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L27) +[types/graph.ts:27](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L27) ___ @@ -1153,7 +1153,7 @@ Change the renderer at runtime. #### Defined in -[types/graph.ts:58](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L58) +[types/graph.ts:58](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L58) ___ @@ -1173,7 +1173,7 @@ Clear the graph, means remove all the items on the graph. #### Defined in -[types/graph.ts:153](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L153) +[types/graph.ts:153](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L153) ___ @@ -1201,7 +1201,7 @@ more convenient way without manually invoking `startBatch` and `stopBatch`. #### Defined in -[types/graph.ts:753](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L753) +[types/graph.ts:753](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L753) ___ @@ -1211,7 +1211,7 @@ ___ #### Defined in -[types/graph.ts:30](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L30) +[types/graph.ts:30](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L30) ___ @@ -1221,7 +1221,7 @@ ___ #### Defined in -[types/graph.ts:29](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L29) +[types/graph.ts:29](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L29) ___ @@ -1247,17 +1247,17 @@ Execute a callback without allowing any stacking operations. #### Defined in -[types/graph.ts:687](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L687) +[types/graph.ts:687](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L687) ___ ### getComboChildrenData -• **getComboChildrenData**: (`comboId`: `ID`) => ([`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel))[] +• **getComboChildrenData**: (`comboId`: `ID`) => ([`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel))[] #### Type declaration -▸ (`comboId`): ([`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel))[] +▸ (`comboId`): ([`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel))[] ##### Parameters @@ -1267,11 +1267,11 @@ ___ ##### Returns -([`NodeModel`](../modules/types.md#nodemodel) \| [`ComboModel`](../modules/types.md#combomodel))[] +([`NodeModel`](../modules/types.en.md#nodemodel) \| [`ComboModel`](../modules/types.en.md#combomodel))[] #### Defined in -[types/graph.ts:132](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L132) +[types/graph.ts:132](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L132) ___ @@ -1299,17 +1299,17 @@ visibility for the item, false for invisible or unexistence for the item #### Defined in -[types/graph.ts:542](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L542) +[types/graph.ts:542](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L542) ___ ### getNearEdgesForNode -• **getNearEdgesForNode**: (`nodeId`: `ID`) => [`EdgeModel`](../modules/types.md#edgemodel)[] +• **getNearEdgesForNode**: (`nodeId`: `ID`) => [`EdgeModel`](../modules/types.en.md#edgemodel)[] #### Type declaration -▸ (`nodeId`): [`EdgeModel`](../modules/types.md#edgemodel)[] +▸ (`nodeId`): [`EdgeModel`](../modules/types.en.md#edgemodel)[] Retrieve the nearby edges for a given node using quadtree collision detection. @@ -1321,13 +1321,13 @@ Retrieve the nearby edges for a given node using quadtree collision detection. ##### Returns -[`EdgeModel`](../modules/types.md#edgemodel)[] +[`EdgeModel`](../modules/types.en.md#edgemodel)[] edges #### Defined in -[types/graph.ts:125](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L125) +[types/graph.ts:125](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L125) ___ @@ -1347,7 +1347,7 @@ Retrieve the current undo stack which consists of operations that were undone #### Defined in -[types/graph.ts:696](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L696) +[types/graph.ts:696](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L696) ___ @@ -1377,29 +1377,29 @@ rendering bounding box. returns false if the item is not exist #### Defined in -[types/graph.ts:531](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L531) +[types/graph.ts:531](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L531) ___ ### getSpecification -• **getSpecification**: () => [`Specification`](types-Specification.md)<`B`, `T`\> +• **getSpecification**: () => [`Specification`](types-Specification.en.md)<`B`, `T`\> #### Type declaration -▸ (): [`Specification`](types-Specification.md)<`B`, `T`\> +▸ (): [`Specification`](types-Specification.en.md)<`B`, `T`\> Get the copy of specs(configurations). ##### Returns -[`Specification`](types-Specification.md)<`B`, `T`\> +[`Specification`](types-Specification.en.md)<`B`, `T`\> graph specs #### Defined in -[types/graph.ts:52](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L52) +[types/graph.ts:52](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L52) ___ @@ -1419,7 +1419,7 @@ Retrieve the complete history stack #### Defined in -[types/graph.ts:702](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L702) +[types/graph.ts:702](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L702) ___ @@ -1439,7 +1439,7 @@ Retrieve the current redo stack which consists of operations that could be undon #### Defined in -[types/graph.ts:691](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L691) +[types/graph.ts:691](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L691) ___ @@ -1459,7 +1459,7 @@ Return the center of viewport, e.g. for a 500 * 500 canvas, its center is [250, #### Defined in -[types/graph.ts:381](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L381) +[types/graph.ts:381](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L381) ___ @@ -1481,7 +1481,7 @@ current zoom #### Defined in -[types/graph.ts:319](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L319) +[types/graph.ts:319](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L319) ___ @@ -1491,7 +1491,7 @@ ___ #### Defined in -[types/graph.ts:26](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L26) +[types/graph.ts:26](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L26) ___ @@ -1511,13 +1511,13 @@ Determine if history (redo/undo) is enabled. #### Defined in -[types/graph.ts:667](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L667) +[types/graph.ts:667](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L667) ___ ### layout -• **layout**: (`options?`: [`LayoutOptions`](../modules/types.md#layoutoptions), `disableAnimate?`: `boolean`) => `Promise`<`void`\> +• **layout**: (`options?`: [`LayoutOptions`](../modules/types.en.md#layoutoptions), `disableAnimate?`: `boolean`) => `Promise`<`void`\> #### Type declaration @@ -1529,7 +1529,7 @@ Layout the graph (with current configurations if cfg is not assigned). | Name | Type | | :------ | :------ | -| `options?` | [`LayoutOptions`](../modules/types.md#layoutoptions) | +| `options?` | [`LayoutOptions`](../modules/types.en.md#layoutoptions) | | `disableAnimate?` | `boolean` | ##### Returns @@ -1538,7 +1538,7 @@ Layout the graph (with current configurations if cfg is not assigned). #### Defined in -[types/graph.ts:577](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L577) +[types/graph.ts:577](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L577) ___ @@ -1558,7 +1558,7 @@ Pause stacking operation. #### Defined in -[types/graph.ts:678](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L678) +[types/graph.ts:678](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L678) ___ @@ -1585,7 +1585,7 @@ Push the operation(s) onto the specified stack #### Defined in -[types/graph.ts:674](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L674) +[types/graph.ts:674](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L674) ___ @@ -1605,7 +1605,7 @@ Restore the operation that was last n reverted on the graph. #### Defined in -[types/graph.ts:714](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L714) +[types/graph.ts:714](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L714) ___ @@ -1615,7 +1615,7 @@ ___ #### Defined in -[types/graph.ts:31](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L31) +[types/graph.ts:31](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L31) ___ @@ -1635,7 +1635,7 @@ Resume stacking operation. #### Defined in -[types/graph.ts:682](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L682) +[types/graph.ts:682](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L682) ___ @@ -1663,7 +1663,7 @@ Rotate the graph with a relative angle in clockwise. #### Defined in -[types/graph.ts:348](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L348) +[types/graph.ts:348](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L348) ___ @@ -1691,7 +1691,7 @@ Rotate the graph to an absolute angle in clockwise. #### Defined in -[types/graph.ts:359](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L359) +[types/graph.ts:359](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L359) ___ @@ -1713,7 +1713,7 @@ treated as a single operation when undoing or redoing. #### Defined in -[types/graph.ts:731](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L731) +[types/graph.ts:731](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L731) ___ @@ -1735,7 +1735,7 @@ treated as a single operation when undoing or redoing. #### Defined in -[types/graph.ts:738](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L738) +[types/graph.ts:738](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L738) ___ @@ -1753,7 +1753,7 @@ ___ #### Defined in -[types/graph.ts:578](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L578) +[types/graph.ts:578](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L578) ___ @@ -1773,7 +1773,7 @@ Stop the current transition of transform immediately. #### Defined in -[types/graph.ts:377](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L377) +[types/graph.ts:377](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L377) ___ @@ -1800,7 +1800,7 @@ Transform the graph with a CSS-Transform-like syntax. #### Defined in -[types/graph.ts:370](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L370) +[types/graph.ts:370](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L370) ___ @@ -1810,7 +1810,7 @@ ___ #### Defined in -[types/graph.ts:28](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L28) +[types/graph.ts:28](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L28) ___ @@ -1837,7 +1837,7 @@ Move the graph with a relative vector. #### Defined in -[types/graph.ts:298](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L298) +[types/graph.ts:298](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L298) ___ @@ -1864,7 +1864,7 @@ Move the graph and align to a point. #### Defined in -[types/graph.ts:311](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L311) +[types/graph.ts:311](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L311) ___ @@ -1884,17 +1884,17 @@ Revert the last n operation(s) on the graph. #### Defined in -[types/graph.ts:708](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L708) +[types/graph.ts:708](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L708) ___ ### updateSpecification -• **updateSpecification**: (`spec`: [`Specification`](types-Specification.md)<`B`, `T`\>) => [`Specification`](types-Specification.md)<`B`, `T`\> +• **updateSpecification**: (`spec`: [`Specification`](types-Specification.en.md)<`B`, `T`\>) => [`Specification`](types-Specification.en.md)<`B`, `T`\> #### Type declaration -▸ (`spec`): [`Specification`](types-Specification.md)<`B`, `T`\> +▸ (`spec`): [`Specification`](types-Specification.en.md)<`B`, `T`\> Update the specs (configurations). @@ -1902,15 +1902,15 @@ Update the specs (configurations). | Name | Type | | :------ | :------ | -| `spec` | [`Specification`](types-Specification.md)<`B`, `T`\> | +| `spec` | [`Specification`](types-Specification.en.md)<`B`, `T`\> | ##### Returns -[`Specification`](types-Specification.md)<`B`, `T`\> +[`Specification`](types-Specification.en.md)<`B`, `T`\> #### Defined in -[types/graph.ts:43](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L43) +[types/graph.ts:43](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L43) ___ @@ -1936,7 +1936,7 @@ Update the theme specs (configurations). #### Defined in -[types/graph.ts:47](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L47) +[types/graph.ts:47](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L47) ___ @@ -1964,7 +1964,7 @@ Zoom the graph with a relative ratio. #### Defined in -[types/graph.ts:326](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L326) +[types/graph.ts:326](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L326) ___ @@ -1992,7 +1992,7 @@ Zoom the graph to a specified ratio. #### Defined in -[types/graph.ts:337](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L337) +[types/graph.ts:337](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L337) ## Tree @@ -2020,7 +2020,7 @@ Collapse sub tree(s). #### Defined in -[types/graph.ts:763](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L763) +[types/graph.ts:763](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L763) ___ @@ -2048,7 +2048,7 @@ Expand sub tree(s). #### Defined in -[types/graph.ts:772](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L772) +[types/graph.ts:772](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L772) ## View @@ -2074,7 +2074,7 @@ Fit the graph center to the view center. #### Defined in -[types/graph.ts:403](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L403) +[types/graph.ts:403](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L403) ___ @@ -2103,7 +2103,7 @@ Fit the graph content to the view. #### Defined in -[types/graph.ts:390](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L390) +[types/graph.ts:390](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L390) ___ @@ -2130,7 +2130,7 @@ Move the graph to make the item align the view center. #### Defined in -[types/graph.ts:410](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L410) +[types/graph.ts:410](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L410) ___ @@ -2158,7 +2158,7 @@ rendering coordinate #### Defined in -[types/graph.ts:457](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L457) +[types/graph.ts:457](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L457) ___ @@ -2186,7 +2186,7 @@ canvas dom (viewport) coordinate #### Defined in -[types/graph.ts:433](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L433) +[types/graph.ts:433](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L433) ___ @@ -2214,7 +2214,7 @@ browser coordinate #### Defined in -[types/graph.ts:449](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L449) +[types/graph.ts:449](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L449) ___ @@ -2236,7 +2236,7 @@ Get the size of the graph canvas. #### Defined in -[types/graph.ts:419](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L419) +[types/graph.ts:419](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L419) ___ @@ -2264,7 +2264,7 @@ rendering coordinate #### Defined in -[types/graph.ts:441](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L441) +[types/graph.ts:441](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L441) ___ @@ -2290,4 +2290,4 @@ Set the size for the graph canvas. #### Defined in -[types/graph.ts:425](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/graph.ts#L425) +[types/graph.ts:425](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/graph.ts#L425) diff --git a/packages/site/docs/apis/interfaces/types-IGraph.zh.md b/packages/site/docs/apis/interfaces/types-IGraph.zh.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/site/docs/apis/interfaces/types-NodeEncode.md b/packages/site/docs/apis/interfaces/types-NodeEncode.en.md similarity index 82% rename from packages/site/docs/apis/interfaces/types-NodeEncode.md rename to packages/site/docs/apis/interfaces/types-NodeEncode.en.md index 3b685f08a0..058adc1a54 100644 --- a/packages/site/docs/apis/interfaces/types-NodeEncode.md +++ b/packages/site/docs/apis/interfaces/types-NodeEncode.en.md @@ -1,8 +1,8 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / NodeEncode +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [types](../modules/types.en.md) / NodeEncode # Interface: NodeEncode -[types](../modules/types.md).NodeEncode +[types](../modules/types.en.md).NodeEncode ## Hierarchy @@ -22,7 +22,7 @@ NodeShapesEncode.anchorShapes #### Defined in -[types/node.ts:155](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/node.ts#L155) +[types/node.ts:156](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L156) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[types/node.ts:160](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/node.ts#L160) +[types/node.ts:161](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L161) ___ @@ -46,7 +46,7 @@ NodeShapesEncode.badgeShapes #### Defined in -[types/node.ts:156](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/node.ts#L156) +[types/node.ts:157](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L157) ___ @@ -60,7 +60,7 @@ NodeShapesEncode.iconShape #### Defined in -[types/item.ts:89](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/item.ts#L89) +[types/item.ts:89](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/item.ts#L89) ___ @@ -74,7 +74,7 @@ NodeShapesEncode.keyShape #### Defined in -[types/item.ts:88](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/item.ts#L88) +[types/item.ts:88](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/item.ts#L88) ___ @@ -88,7 +88,7 @@ NodeShapesEncode.labelBackgroundShape #### Defined in -[types/node.ts:154](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/node.ts#L154) +[types/node.ts:155](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L155) ___ @@ -102,7 +102,7 @@ NodeShapesEncode.labelShape #### Defined in -[types/node.ts:153](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/node.ts#L153) +[types/node.ts:154](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L154) ___ @@ -120,7 +120,7 @@ NodeShapesEncode.otherShapes #### Defined in -[types/item.ts:90](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/item.ts#L90) +[types/item.ts:90](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/item.ts#L90) ___ @@ -130,4 +130,4 @@ ___ #### Defined in -[types/node.ts:159](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/node.ts#L159) +[types/node.ts:160](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L160) diff --git a/packages/site/docs/apis/interfaces/types-NodeEncode.zh.md b/packages/site/docs/apis/interfaces/types-NodeEncode.zh.md new file mode 100644 index 0000000000..6dc17ca4e0 --- /dev/null +++ b/packages/site/docs/apis/interfaces/types-NodeEncode.zh.md @@ -0,0 +1,133 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [类型](../modules/types.zh.md ) / 节点编码 + + # 接口:NodeEncode + + [类型](../modules/types.zh.md).NodeEncode + + ## 等级制度 + + - `NodeShapesEncode` + + ↳ **`节点编码`** + + ## 特性 + + ### 锚定形状 + + • `可选` **anchorShapes**:`编码`<`Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `动画?`: `IAnimates` ; `lod?`: `数字`; `可见?`: `布尔值` }\>[]\> \| `ShapeAttrEncode`[] + + ####继承自 + + NodeShapesEncode.anchorShapes + + #### 定义于 + + [类型/node.ts:156](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L156) + + ___ + + ### 动画 + + • `可选` **动画**:`IAnimates` + + #### 定义于 + + [类型/node.ts:161](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L161) + + ___ + + ### 徽章形状 + + • `可选` **badgeShapes**:`Encode`<`Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `动画?`: `IAnimates` ; `lod?`: `数字`; `可见?`: `布尔值` }\>[]\> \| `ShapeAttrEncode`[] + + ####继承自 + + NodeShapesEncode.badgeShapes + + #### 定义于 + + [类型/node.ts:157](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L157) + + ___ + + ### 图标形状 + + • `可选` **iconShape**:`ShapeAttrEncode` \| `Encode`<`Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps ` & `PlaneGeometryProps` & { `动画?`: `IAnimates` ; `lod?`: `数字`; `可见?`: `布尔值` }\>\> + + ####继承自 + + NodeShapesEncode.iconShape + + #### 定义于 + + [类型/item.ts:89](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/item.ts#L89) + + ___ + + ### keyShape + + • `可选` **keyShape**:`ShapeAttrEncode` \| `Encode`<`Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps ` & `PlaneGeometryProps` & { `动画?`: `IAnimates` ; `lod?`: `数字`; `可见?`: `布尔值` }\>\> + + ####继承自 + + NodeShapesEncode.keyShape + + #### 定义于 + + [类型/item.ts:88](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/item.ts#L88) + + ___ + + ### 标签背景形状 + + • `可选` **labelBackgroundShape**:`编码`<`Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `动画?`: `IAnimates` ; `lod?`: `数字`; `可见?`: `布尔值` }\>[]\> \| `ShapeAttrEncode`[] + + ####继承自 + + NodeShapesEncode.labelBackgroundShape + + #### 定义于 + + [类型/node.ts:155](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L155) + + ___ + + ### 标签形状 + + • `可选` **labelShape**:`编码`<`部分`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `动画?`: `IAnimates` ; `lod?`: `数字`; `可见?`: `布尔值` }\>\> \| `NodeLabelShapeAttrEncode` + + ####继承自 + + NodeShapesEncode.labelShape + + #### 定义于 + + [类型/node.ts:154](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L154) + + ___ + + ### 其他形状 + + • `可选` **otherShapes**:`对象` + + #### 索引签名 + + ▪ [shapeId: `string`]: { `[shapeAtrr: string]`: `未知` \| `编码`<`未知`\>; `animates`: `IAnimates` \| `编码`<`IAnimates`\> } + + ####继承自 + + NodeShapesEncode.otherShapes + + #### 定义于 + + [类型/item.ts:90](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/item.ts#L90) + + ___ + + ### 类型 + + • `可选` **类型**:`字符串` \| `编码`<`字符串`\> + + #### 定义于 + + [类型/node.ts:160](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L160) \ No newline at end of file diff --git a/packages/site/docs/apis/interfaces/types-Specification.en.md b/packages/site/docs/apis/interfaces/types-Specification.en.md new file mode 100644 index 0000000000..807df8d7e9 --- /dev/null +++ b/packages/site/docs/apis/interfaces/types-Specification.en.md @@ -0,0 +1,304 @@ +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [types](../modules/types.en.md) / Specification + +# Interface: Specification + +[types](../modules/types.en.md).Specification + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `B` | extends `BehaviorRegistry` | +| `T` | extends `ThemeRegistry` | + +## Properties + +### animate + +• `Optional` **animate**: `AnimateCfg` + +global animate + +#### Defined in + +[types/spec.ts:113](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L113) + +___ + +### autoFit + +• `Optional` **autoFit**: ``"center"`` \| ``"view"`` \| { `effectTiming?`: `Partial`<`Pick`<`IAnimationEffectTiming`, ``"duration"`` \| ``"easing"`` \| ``"easingFunction"``\>\> ; `padding?`: `Padding` ; `rules?`: `FitViewRules` ; `type`: ``"view"`` } \| { `effectTiming?`: `Partial`<`Pick`<`IAnimationEffectTiming`, ``"duration"`` \| ``"easing"`` \| ``"easingFunction"``\>\> ; `type`: ``"center"`` } \| { `alignment?`: `GraphAlignment` ; `effectTiming?`: `Partial`<`Pick`<`IAnimationEffectTiming`, ``"duration"`` \| ``"easing"`` \| ``"easingFunction"``\>\> ; `position`: `Point` ; `type`: ``"position"`` } + +#### Defined in + +[types/spec.ts:49](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L49) + +___ + +### backgroundCanvas + +• `Optional` **backgroundCanvas**: `Canvas` + +#### Defined in + +[types/spec.ts:36](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L36) + +___ + +### canvas + +• `Optional` **canvas**: `Canvas` + +#### Defined in + +[types/spec.ts:37](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L37) + +___ + +### combo + +• `Optional` **combo**: `ComboEncode` \| (`data`: [`ComboModel`](../modules/types.en.md#combomodel)) => [`ComboDisplayModel`](../modules/types.en.md#combodisplaymodel) + +#### Defined in + +[types/spec.ts:83](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L83) + +___ + +### comboState + +• `Optional` **comboState**: `Object` + +#### Index signature + +▪ [stateName: `string`]: (`data`: [`ComboModel`](../modules/types.en.md#combomodel)) => [`ComboDisplayModel`](../modules/types.en.md#combodisplaymodel) \| `ComboShapesEncode` + +#### Defined in + +[types/spec.ts:96](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L96) + +___ + +### container + +• `Optional` **container**: `string` \| `HTMLElement` + +#### Defined in + +[types/spec.ts:35](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L35) + +___ + +### data + +• `Optional` **data**: `DataConfig` + +data + +#### Defined in + +[types/spec.ts:71](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L71) + +___ + +### edge + +• `Optional` **edge**: `EdgeEncode` \| (`data`: [`EdgeModel`](../modules/types.en.md#edgemodel)) => [`EdgeDisplayModel`](../modules/types.en.md#edgedisplaymodel) + +#### Defined in + +[types/spec.ts:82](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L82) + +___ + +### edgeState + +• `Optional` **edgeState**: `Object` + +#### Index signature + +▪ [stateName: `string`]: (`data`: [`EdgeModel`](../modules/types.en.md#edgemodel)) => [`EdgeDisplayModel`](../modules/types.en.md#edgedisplaymodel) \| `EdgeShapesEncode` + +#### Defined in + +[types/spec.ts:91](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L91) + +___ + +### enableStack + +• `Optional` **enableStack**: `boolean` + +#### Defined in + +[types/spec.ts:128](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L128) + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +[types/spec.ts:40](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L40) + +___ + +### layout + +• `Optional` **layout**: [`LayoutOptions`](../modules/types.en.md#layoutoptions) \| [`LayoutOptions`](../modules/types.en.md#layoutoptions)[] + +layout + +#### Defined in + +[types/spec.ts:103](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L103) + +___ + +### mode + +• `Optional` **mode**: `string` + +#### Defined in + +[types/spec.ts:110](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L110) + +___ + +### modes + +• `Optional` **modes**: `Object` + +interaction + +#### Index signature + +▪ [mode: `string`]: `BehaviorOptionsOf`<`B`\>[] + +#### Defined in + +[types/spec.ts:106](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L106) + +___ + +### node + +• `Optional` **node**: [`NodeEncode`](types-NodeEncode.en.md) \| (`data`: [`NodeModel`](../modules/types.en.md#nodemodel)) => [`NodeDisplayModel`](../modules/types.en.md#nodedisplaymodel) + +item + +#### Defined in + +[types/spec.ts:81](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L81) + +___ + +### nodeState + +• `Optional` **nodeState**: `Object` + +item state styles + +#### Index signature + +▪ [stateName: `string`]: (`data`: [`NodeModel`](../modules/types.en.md#nodemodel)) => [`NodeDisplayModel`](../modules/types.en.md#nodedisplaymodel) \| `NodeShapesEncode` + +#### Defined in + +[types/spec.ts:86](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L86) + +___ + +### optimizeThreshold + +• `Optional` **optimizeThreshold**: `number` + +#### Defined in + +[types/spec.ts:68](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L68) + +___ + +### plugins + +• `Optional` **plugins**: (`string` \| { `[cfgName: string]`: `unknown`; `key`: `string` ; `type`: `string` })[] + +free plugins + +#### Defined in + +[types/spec.ts:116](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L116) + +___ + +### renderer + +• `Optional` **renderer**: `RendererName` \| { `headless`: `boolean` ; `pixelRatio`: `number` ; `type`: `RendererName` } + +#### Defined in + +[types/spec.ts:41](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L41) + +___ + +### stackCfg + +• `Optional` **stackCfg**: `StackCfg` + +#### Defined in + +[types/spec.ts:130](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L130) + +___ + +### theme + +• `Optional` **theme**: `ThemeOptionsOf`<`T`\> + +theme + +#### Defined in + +[types/spec.ts:126](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L126) + +___ + +### transform + +• `Optional` **transform**: `string`[] \| { `[param: string]`: `unknown`; `type`: `string` }[] \| `TransformerFn`[] + +#### Defined in + +[types/spec.ts:72](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L72) + +___ + +### transientCanvas + +• `Optional` **transientCanvas**: `Canvas` + +#### Defined in + +[types/spec.ts:38](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L38) + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +[types/spec.ts:39](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L39) + +___ + +### zoom + +• `Optional` **zoom**: `number` + +#### Defined in + +[types/spec.ts:48](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/spec.ts#L48) diff --git a/packages/site/docs/apis/interfaces/types-Specification.md b/packages/site/docs/apis/interfaces/types-Specification.md deleted file mode 100644 index 129ae26ec4..0000000000 --- a/packages/site/docs/apis/interfaces/types-Specification.md +++ /dev/null @@ -1,304 +0,0 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / Specification - -# Interface: Specification - -[types](../modules/types.md).Specification - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `B` | extends `BehaviorRegistry` | -| `T` | extends `ThemeRegistry` | - -## Properties - -### animate - -• `Optional` **animate**: `AnimateCfg` - -global animate - -#### Defined in - -[types/spec.ts:101](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L101) - -___ - -### autoFit - -• `Optional` **autoFit**: ``"center"`` \| ``"view"`` \| { `alignment`: `GraphAlignment` ; `position`: `Point` } - -#### Defined in - -[types/spec.ts:49](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L49) - -___ - -### backgroundCanvas - -• `Optional` **backgroundCanvas**: `Canvas` - -#### Defined in - -[types/spec.ts:36](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L36) - -___ - -### canvas - -• `Optional` **canvas**: `Canvas` - -#### Defined in - -[types/spec.ts:37](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L37) - -___ - -### combo - -• `Optional` **combo**: `ComboEncode` \| (`data`: [`ComboModel`](../modules/types.md#combomodel)) => [`ComboDisplayModel`](../modules/types.md#combodisplaymodel) - -#### Defined in - -[types/spec.ts:71](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L71) - -___ - -### comboState - -• `Optional` **comboState**: `Object` - -#### Index signature - -▪ [stateName: `string`]: (`data`: [`ComboModel`](../modules/types.md#combomodel)) => [`ComboDisplayModel`](../modules/types.md#combodisplaymodel) \| `ComboShapesEncode` - -#### Defined in - -[types/spec.ts:84](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L84) - -___ - -### container - -• `Optional` **container**: `string` \| `HTMLElement` - -#### Defined in - -[types/spec.ts:35](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L35) - -___ - -### data - -• `Optional` **data**: `DataConfig` - -data - -#### Defined in - -[types/spec.ts:59](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L59) - -___ - -### edge - -• `Optional` **edge**: `EdgeEncode` \| (`data`: [`EdgeModel`](../modules/types.md#edgemodel)) => [`EdgeDisplayModel`](../modules/types.md#edgedisplaymodel) - -#### Defined in - -[types/spec.ts:70](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L70) - -___ - -### edgeState - -• `Optional` **edgeState**: `Object` - -#### Index signature - -▪ [stateName: `string`]: (`data`: [`EdgeModel`](../modules/types.md#edgemodel)) => [`EdgeDisplayModel`](../modules/types.md#edgedisplaymodel) \| `EdgeShapesEncode` - -#### Defined in - -[types/spec.ts:79](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L79) - -___ - -### enableStack - -• `Optional` **enableStack**: `boolean` - -#### Defined in - -[types/spec.ts:116](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L116) - -___ - -### height - -• `Optional` **height**: `number` - -#### Defined in - -[types/spec.ts:40](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L40) - -___ - -### layout - -• `Optional` **layout**: [`LayoutOptions`](../modules/types.md#layoutoptions) \| [`LayoutOptions`](../modules/types.md#layoutoptions)[] - -layout - -#### Defined in - -[types/spec.ts:91](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L91) - -___ - -### mode - -• `Optional` **mode**: `string` - -#### Defined in - -[types/spec.ts:98](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L98) - -___ - -### modes - -• `Optional` **modes**: `Object` - -interaction - -#### Index signature - -▪ [mode: `string`]: `BehaviorOptionsOf`<`B`\>[] - -#### Defined in - -[types/spec.ts:94](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L94) - -___ - -### node - -• `Optional` **node**: [`NodeEncode`](types-NodeEncode.md) \| (`data`: [`NodeModel`](../modules/types.md#nodemodel)) => [`NodeDisplayModel`](../modules/types.md#nodedisplaymodel) - -item - -#### Defined in - -[types/spec.ts:69](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L69) - -___ - -### nodeState - -• `Optional` **nodeState**: `Object` - -item state styles - -#### Index signature - -▪ [stateName: `string`]: (`data`: [`NodeModel`](../modules/types.md#nodemodel)) => [`NodeDisplayModel`](../modules/types.md#nodedisplaymodel) \| `NodeShapesEncode` - -#### Defined in - -[types/spec.ts:74](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L74) - -___ - -### optimizeThreshold - -• `Optional` **optimizeThreshold**: `number` - -#### Defined in - -[types/spec.ts:56](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L56) - -___ - -### plugins - -• `Optional` **plugins**: (`string` \| { `[cfgName: string]`: `unknown`; `key`: `string` ; `type`: `string` })[] - -free plugins - -#### Defined in - -[types/spec.ts:104](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L104) - -___ - -### renderer - -• `Optional` **renderer**: `RendererName` \| { `headless`: `boolean` ; `pixelRatio`: `number` ; `type`: `RendererName` } - -#### Defined in - -[types/spec.ts:41](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L41) - -___ - -### stackCfg - -• `Optional` **stackCfg**: `StackCfg` - -#### Defined in - -[types/spec.ts:118](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L118) - -___ - -### theme - -• `Optional` **theme**: `ThemeOptionsOf`<`T`\> - -theme - -#### Defined in - -[types/spec.ts:114](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L114) - -___ - -### transform - -• `Optional` **transform**: `string`[] \| { `[param: string]`: `unknown`; `type`: `string` }[] \| `TransformerFn`[] - -#### Defined in - -[types/spec.ts:60](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L60) - -___ - -### transientCanvas - -• `Optional` **transientCanvas**: `Canvas` - -#### Defined in - -[types/spec.ts:38](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L38) - -___ - -### width - -• `Optional` **width**: `number` - -#### Defined in - -[types/spec.ts:39](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L39) - -___ - -### zoom - -• `Optional` **zoom**: `number` - -#### Defined in - -[types/spec.ts:48](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/spec.ts#L48) diff --git a/packages/site/docs/apis/interfaces/types-Specification.zh.md b/packages/site/docs/apis/interfaces/types-Specification.zh.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/site/docs/apis/modules.en.md b/packages/site/docs/apis/modules.en.md new file mode 100644 index 0000000000..2d5110b974 --- /dev/null +++ b/packages/site/docs/apis/modules.en.md @@ -0,0 +1,11 @@ +[Overview - v5.0.0-alpha.9](README.en.md) / Modules + +# Overview - v5.0.0-alpha.9 + +## Modules + +- [behaviors](modules/behaviors.en.md) +- [graph](modules/graph.en.md) +- [plugins](modules/plugins.en.md) +- [types](modules/types.en.md) +- [util](modules/util.en.md) diff --git a/packages/site/docs/apis/modules.md b/packages/site/docs/apis/modules.md deleted file mode 100644 index 02e1f5b8a0..0000000000 --- a/packages/site/docs/apis/modules.md +++ /dev/null @@ -1,11 +0,0 @@ -[Overview - v5.0.0-alpha.9](README.md) / Modules - -# Overview - v5.0.0-alpha.9 - -## Modules - -- [behaviors](modules/behaviors.md) -- [graph](modules/graph.md) -- [plugins](modules/plugins.md) -- [types](modules/types.md) -- [util](modules/util.md) diff --git a/packages/site/docs/apis/modules.zh.md b/packages/site/docs/apis/modules.zh.md new file mode 100644 index 0000000000..344ddb87d6 --- /dev/null +++ b/packages/site/docs/apis/modules.zh.md @@ -0,0 +1,11 @@ +[概述 - v5.0.0-alpha.9](README.zh.md) / 模块 + +# 概述 - v5.0.0-alpha.9 + +## 模块 + +- [行为](modules/behaviors.zh.md) +- [graph](modules/graph.zh.md) +- [插件](modules/plugins.zh.md) +- [类型](modules/types.zh.md) +- [util](modules/util.zh.md) diff --git a/packages/site/docs/apis/modules/behaviors.md b/packages/site/docs/apis/modules/behaviors.en.md similarity index 58% rename from packages/site/docs/apis/modules/behaviors.md rename to packages/site/docs/apis/modules/behaviors.en.md index e71002daad..0cad1ef57e 100644 --- a/packages/site/docs/apis/modules/behaviors.md +++ b/packages/site/docs/apis/modules/behaviors.en.md @@ -1,8 +1,8 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / behaviors +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / behaviors # Module: behaviors ## Interfaces -- [ActivateRelationsOptions](../interfaces/behaviors-ActivateRelationsOptions.md) -- [BrushSelectOptions](../interfaces/behaviors-BrushSelectOptions.md) +- [ActivateRelationsOptions](../interfaces/behaviors-ActivateRelationsOptions.en.md) +- [BrushSelectOptions](../interfaces/behaviors-BrushSelectOptions.en.md) diff --git a/packages/site/docs/apis/modules/behaviors.zh.md b/packages/site/docs/apis/modules/behaviors.zh.md new file mode 100644 index 0000000000..41aee31871 --- /dev/null +++ b/packages/site/docs/apis/modules/behaviors.zh.md @@ -0,0 +1,8 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / 行为 + + # 模块:行为 + + ## 接口 + + - [ActivateRelationsOptions](../interfaces/behaviors-ActivateRelationsOptions.zh.md) + - [BrushSelectOptions](../interfaces/behaviors-BrushSelectOptions.zh.md) \ No newline at end of file diff --git a/packages/site/docs/apis/modules/graph.md b/packages/site/docs/apis/modules/graph.en.md similarity index 61% rename from packages/site/docs/apis/modules/graph.md rename to packages/site/docs/apis/modules/graph.en.md index 1d67a9e776..14791bcec7 100644 --- a/packages/site/docs/apis/modules/graph.md +++ b/packages/site/docs/apis/modules/graph.en.md @@ -1,10 +1,10 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / graph +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / graph # Module: graph ## Classes -- [Graph](../classes/graph-Graph.md) +- [Graph](../classes/graph-Graph.en.md) ## Variables @@ -16,10 +16,10 @@ | Name | Type | | :------ | :------ | -| `extend` | (`GraphClass`: typeof [`Graph`](../classes/graph-Graph.md), `extendLibrary`: { `behaviors?`: `B1` ; `edges?`: `any` ; `nodes?`: `any` ; `themeSolvers?`: `T1` }) => typeof [`Graph`](../classes/graph-Graph.md) | +| `extend` | (`GraphClass`: typeof [`Graph`](../classes/graph-Graph.en.md), `extendLibrary`: { `behaviors?`: `B1` ; `edges?`: `any` ; `nodes?`: `any` ; `themeSolvers?`: `T1` }) => typeof [`Graph`](../classes/graph-Graph.en.md) | | `isEncode` | (`value`: `any`) => value is Encode | | `mock` | (`nodeCount`: `number`) => { `circle`: (`centerId`: `string`) => { `edges`: `any`[] ; `nodes`: { `data`: {} = {}; `id`: `string` }[] } ; `random`: (`ratio`: `number`) => { `edges`: `any`[] ; `nodes`: { `data`: {} = {}; `id`: `string` }[] } } | #### Defined in -[util/index.ts:4](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/util/index.ts#L4) +[util/index.ts:4](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/util/index.ts#L4) diff --git a/packages/site/docs/apis/modules/graph.zh.md b/packages/site/docs/apis/modules/graph.zh.md new file mode 100644 index 0000000000..67737519c0 --- /dev/null +++ b/packages/site/docs/apis/modules/graph.zh.md @@ -0,0 +1,25 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / 图 + + # 模块:图 + + ## 课程 + + - [图](../classes/graph-Graph.zh.md) + + ## 变量 + + ### 实用程序 + + • `Const` **Util**:`对象` + + #### 类型声明 + + | 名称 | 类型 | + | :------ | :------ | + | `扩展` | (`GraphClass`: typeof [`Graph`](../classes/graph-Graph.zh.md), `extendLibrary`: { `行为?`: `B1` ; `边?`:`任何`;`节点?`:`任何`;`themeSolvers?`:`T1` }) => typeof [`Graph`](../classes/graph-Graph.zh.md) | + | `isEncode` | (`value`: `any`) => 值为 Encode | + | `模拟` | (`nodeCount`: `number`) => { `circle`: (`centerId`: `string`) => { `edges`: `any`[] ; `节点`: { `数据`: {} = {}; `id`: `字符串` }[] } ; `random`: (`ratio`: `number`) => { `edges`: `any`[] ; `节点`: { `数据`: {} = {}; `id`: `字符串` }[] } } | + + #### 定义于 + + [util/index.ts:4](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/util/index.ts#L4) \ No newline at end of file diff --git a/packages/site/docs/apis/modules/plugins.en.md b/packages/site/docs/apis/modules/plugins.en.md new file mode 100644 index 0000000000..8449ffa446 --- /dev/null +++ b/packages/site/docs/apis/modules/plugins.en.md @@ -0,0 +1,10 @@ +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / plugins + +# Module: plugins + +## Interfaces + +- [LegendConfig](../interfaces/plugins-LegendConfig.en.md) +- [MiniMapConfig](../interfaces/plugins-MiniMapConfig.en.md) +- [ToolbarConfig](../interfaces/plugins-ToolbarConfig.en.md) +- [TooltipConfig](../interfaces/plugins-TooltipConfig.en.md) diff --git a/packages/site/docs/apis/modules/plugins.md b/packages/site/docs/apis/modules/plugins.md deleted file mode 100644 index ad5718776e..0000000000 --- a/packages/site/docs/apis/modules/plugins.md +++ /dev/null @@ -1,10 +0,0 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / plugins - -# Module: plugins - -## Interfaces - -- [LegendConfig](../interfaces/plugins-LegendConfig.md) -- [MiniMapConfig](../interfaces/plugins-MiniMapConfig.md) -- [ToolbarConfig](../interfaces/plugins-ToolbarConfig.md) -- [TooltipConfig](../interfaces/plugins-TooltipConfig.md) diff --git a/packages/site/docs/apis/modules/plugins.zh.md b/packages/site/docs/apis/modules/plugins.zh.md new file mode 100644 index 0000000000..39922cf0cd --- /dev/null +++ b/packages/site/docs/apis/modules/plugins.zh.md @@ -0,0 +1,10 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / 插件 + + # 模块:插件 + + ## 接口 + + - [LegendConfig](../interfaces/plugins-LegendConfig.zh.md) + - [MiniMapConfig](../interfaces/plugins-MiniMapConfig.zh.md) + - [ToolbarConfig](../interfaces/plugins-ToolbarConfig.zh.md) + - [TooltipConfig](../interfaces/plugins-TooltipConfig.zh.md) \ No newline at end of file diff --git a/packages/site/docs/apis/modules/types.md b/packages/site/docs/apis/modules/types.en.md similarity index 53% rename from packages/site/docs/apis/modules/types.md rename to packages/site/docs/apis/modules/types.en.md index 5e8bdf3e35..39ae4743a5 100644 --- a/packages/site/docs/apis/modules/types.md +++ b/packages/site/docs/apis/modules/types.en.md @@ -1,14 +1,14 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / types +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / types # Module: types ## Interfaces -- [GraphData](../interfaces/types-GraphData.md) -- [IG6GraphEvent](../interfaces/types-IG6GraphEvent.md) -- [IGraph](../interfaces/types-IGraph.md) -- [NodeEncode](../interfaces/types-NodeEncode.md) -- [Specification](../interfaces/types-Specification.md) +- [GraphData](../interfaces/types-GraphData.en.md) +- [IG6GraphEvent](../interfaces/types-IG6GraphEvent.en.md) +- [IGraph](../interfaces/types-IGraph.en.md) +- [NodeEncode](../interfaces/types-NodeEncode.en.md) +- [Specification](../interfaces/types-Specification.en.md) ## Functions @@ -28,7 +28,7 @@ options is ImmediatelyInvokedLayoutOptions #### Defined in -[types/layout.ts:74](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/layout.ts#L74) +[types/layout.ts:74](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/layout.ts#L74) ___ @@ -40,7 +40,7 @@ ___ | Name | Type | | :------ | :------ | -| `options` | [`StandardLayoutOptions`](types.md#standardlayoutoptions) | +| `options` | [`StandardLayoutOptions`](types.en.md#standardlayoutoptions) | #### Returns @@ -48,7 +48,7 @@ ___ #### Defined in -[types/layout.ts:80](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/layout.ts#L80) +[types/layout.ts:80](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/layout.ts#L80) ## Type Aliases @@ -60,7 +60,7 @@ Displayed model, only for drawing and not received by users. #### Defined in -[types/combo.ts:153](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/combo.ts#L153) +[types/combo.ts:153](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/combo.ts#L153) ___ @@ -72,7 +72,7 @@ Inner node model, clone and transform from user data. #### Defined in -[types/combo.ts:150](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/combo.ts#L150) +[types/combo.ts:150](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/combo.ts#L150) ___ @@ -84,7 +84,7 @@ User input model. #### Defined in -[types/combo.ts:147](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/combo.ts#L147) +[types/combo.ts:147](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/combo.ts#L147) ___ @@ -96,7 +96,7 @@ Displayed data, only for drawing and not received by users. #### Defined in -[types/edge.ts:89](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/edge.ts#L89) +[types/edge.ts:92](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/edge.ts#L92) ___ @@ -108,7 +108,7 @@ Inner node data, clone and transform from user data. #### Defined in -[types/edge.ts:86](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/edge.ts#L86) +[types/edge.ts:89](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/edge.ts#L89) ___ @@ -120,7 +120,7 @@ User input data. #### Defined in -[types/edge.ts:83](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/edge.ts#L83) +[types/edge.ts:86](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/edge.ts#L86) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[types/combo.ts:177](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/combo.ts#L177) +[types/combo.ts:177](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/combo.ts#L177) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[types/edge.ts:119](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/edge.ts#L119) +[types/edge.ts:122](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/edge.ts#L122) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[types/node.ts:173](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/node.ts#L173) +[types/node.ts:174](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L174) ___ @@ -160,17 +160,17 @@ ___ #### Defined in -[types/layout.ts:42](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/layout.ts#L42) +[types/layout.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/layout.ts#L42) ___ ### LayoutOptions -Ƭ **LayoutOptions**: [`StandardLayoutOptions`](types.md#standardlayoutoptions) \| [`ImmediatelyInvokedLayoutOptions`](types.md#immediatelyinvokedlayoutoptions) +Ƭ **LayoutOptions**: [`StandardLayoutOptions`](types.en.md#standardlayoutoptions) \| [`ImmediatelyInvokedLayoutOptions`](types.en.md#immediatelyinvokedlayoutoptions) #### Defined in -[types/layout.ts:70](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/layout.ts#L70) +[types/layout.ts:70](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/layout.ts#L70) ___ @@ -182,19 +182,19 @@ Displayed model, only for drawing and not received by users. #### Defined in -[types/node.ts:143](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/node.ts#L143) +[types/node.ts:144](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L144) ___ ### NodeModel -Ƭ **NodeModel**: `GNode`<[`NodeModelData`](types.md#nodemodeldata)\> +Ƭ **NodeModel**: `GNode`<[`NodeModelData`](types.en.md#nodemodeldata)\> Inner node model, clone and transform from user data. #### Defined in -[types/node.ts:140](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/node.ts#L140) +[types/node.ts:141](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L141) ___ @@ -206,7 +206,7 @@ Data in inner model. Same format to the user data. #### Defined in -[types/node.ts:84](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/node.ts#L84) +[types/node.ts:84](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L84) ___ @@ -218,7 +218,7 @@ User input model. #### Defined in -[types/node.ts:137](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/node.ts#L137) +[types/node.ts:138](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/node.ts#L138) ___ @@ -228,4 +228,4 @@ ___ #### Defined in -[types/layout.ts:54](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/types/layout.ts#L54) +[types/layout.ts:54](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/layout.ts#L54) diff --git a/packages/site/docs/apis/modules/types.zh.md b/packages/site/docs/apis/modules/types.zh.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/site/docs/apis/modules/util.md b/packages/site/docs/apis/modules/util.en.md similarity index 78% rename from packages/site/docs/apis/modules/util.md rename to packages/site/docs/apis/modules/util.en.md index 69308e3965..ce99557355 100644 --- a/packages/site/docs/apis/modules/util.md +++ b/packages/site/docs/apis/modules/util.en.md @@ -1,4 +1,4 @@ -[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / util +[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / util # Module: util @@ -6,7 +6,7 @@ ### extend -▸ **extend**<`B1`, `B2`, `T1`, `T2`\>(`GraphClass`, `extendLibrary`): typeof [`Graph`](../classes/graph-Graph.md) +▸ **extend**<`B1`, `B2`, `T1`, `T2`\>(`GraphClass`, `extendLibrary`): typeof [`Graph`](../classes/graph-Graph.en.md) Extend graph class with custom libs (extendLibrary), and extendLibrary will be merged into useLib. B1 is the Behavior lib from user, B2 is the Behavior lib of the graph to be extended(built-in graph) @@ -25,7 +25,7 @@ TODO: more templates, and might be merged to be two templates for the whole exte | Name | Type | Description | | :------ | :------ | :------ | -| `GraphClass` | typeof [`Graph`](../classes/graph-Graph.md) | graph class to be extended | +| `GraphClass` | typeof [`Graph`](../classes/graph-Graph.en.md) | graph class to be extended | | `extendLibrary` | `Object` | custom libs to extend | | `extendLibrary.behaviors?` | `B1` | - | | `extendLibrary.edges?` | `any` | - | @@ -34,13 +34,13 @@ TODO: more templates, and might be merged to be two templates for the whole exte #### Returns -typeof [`Graph`](../classes/graph-Graph.md) +typeof [`Graph`](../classes/graph-Graph.en.md) extended graph class #### Defined in -[util/extend.ts:14](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/util/extend.ts#L14) +[util/extend.ts:14](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/util/extend.ts#L14) ___ @@ -60,7 +60,7 @@ value is Encode #### Defined in -[util/type.ts:3](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/util/type.ts#L3) +[util/type.ts:3](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/util/type.ts#L3) ___ @@ -87,4 +87,4 @@ mock graph data #### Defined in -[util/mock.ts:7](https://github.com/antvis/G6/blob/f5420ab2ac/packages/g6/src/util/mock.ts#L7) +[util/mock.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/util/mock.ts#L7) diff --git a/packages/site/docs/apis/modules/util.zh.md b/packages/site/docs/apis/modules/util.zh.md new file mode 100644 index 0000000000..259e6ce76c --- /dev/null +++ b/packages/site/docs/apis/modules/util.zh.md @@ -0,0 +1,90 @@ +[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / util + + # 模块:util + + ## 功能 + + ### 延长 + + ▸ **扩展**<`B1`、`B2`、`T1`、`T2`\>(`GraphClass`、`extendLibrary`): typeof [`Graph`](../classes/graph-Graph. zh.md) + + 使用自定义库(extendLibrary)扩展图形类,extendLibrary将合并到useLib中。 + B1是用户的Behavior库,B2是要扩展的图的Behavior库(内置图) + TODO:更多模板,并且可能合并为整个扩展库的两个模板 + + #### 类型参数 + + | 名称 | 类型 | + | :------ | :------ | + | `B1` | 扩展 `BehaviorRegistry` | + | 'B2' | 扩展 `BehaviorRegistry` | + | `T1` | 扩展 `ThemeRegistry` | + | `T2` | 扩展 `ThemeRegistry` | + + #### 参数 + + | 名称 | 类型 | 描述 | + | :------ | :------ | :------ | + | `GraphClass` | typeof [`Graph`](../classes/graph-Graph.zh.md) | 待扩展的图类 | + | `扩展库` | `对象` | 要扩展的自定义库 | + | `extendLibrary.behaviors?` | `B1` | - | + | `extendLibrary.edges?` | `任何` | - | + | `extendLibrary.nodes?` | `任何` | - | + | `extendLibrary.themeSolvers?` | `T1` | - | + + #### 返回 + + typeof [`Graph`](../classes/graph-Graph.zh.md) + + 扩展图类 + + #### 定义于 + + [util/extend.ts:14](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/util/extend.ts#L14) + + ___ + + ### isEncode + + ▸ **isEncode**(`value`): 值为 Encode + + #### 参数 + + | 名称 | 类型 | + | :------ | :------ | + | `价值` | `任何` | + + #### 返回 + + 值为 Encode + + #### 定义于 + + [util/type.ts:3](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/util/type.ts#L3) + + ___ + + ### 嘲笑 + + ▸ **模拟**(`nodeCount`): `对象` + + 模拟图数据 + + #### 参数 + + | 名称 | 类型 | 描述 | + | :------ | :------ | :------ | + | `nodeCount` | `数字` | 节点数 | + + #### 返回 + + `对象` + + | 名称 | 类型 | + | :------ | :------ | + | `圆` | (`centerId`: `string`) => { `edges`: `any`[] ; `节点`: { `数据`: {} = {}; `id`: `字符串` }[] } | + | `随机` | (`ratio`: `number`) => { `edges`: `any`[] ; `节点`: { `数据`: {} = {}; `id`: `字符串` }[] } | + + #### 定义于 + + [util/mock.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/util/mock.ts#L7) \ No newline at end of file diff --git a/packages/site/package.json b/packages/site/package.json index 7f22a9a981..4913385840 100644 --- a/packages/site/package.json +++ b/packages/site/package.json @@ -1,6 +1,6 @@ { "name": "@antv/g6-site", - "version": "4.8.0", + "version": "5.0.0", "private": true, "description": "G6 sites deployed on gh-pages", "keywords": [ @@ -32,6 +32,7 @@ "translate": "node translate-api-doc.mjs" }, "dependencies": { + "fs-extra": "latest", "google-translate-api-x": "^10.6.7", "@faker-js/faker": "^8.0.2", "@ant-design/icons": "^4.0.6", diff --git a/packages/site/translate-api-doc.mjs b/packages/site/translate-api-doc.mjs index 68ceae86bc..cf67420c9d 100644 --- a/packages/site/translate-api-doc.mjs +++ b/packages/site/translate-api-doc.mjs @@ -1,6 +1,6 @@ -import translate from 'google-translate-api-x'; - import fs from 'fs'; +import fsExtra from 'fs-extra'; +import translate from 'google-translate-api-x'; import { readFile, readdir, writeFile } from 'node:fs/promises'; /** @@ -9,71 +9,96 @@ import { readFile, readdir, writeFile } from 'node:fs/promises'; * see : https://github.com/nodejs/node/issues/48858 */ const Readdir = async (path, options) => { - const all = await readdir(path); - const dirs = []; - const files = []; - - all.forEach((item) => { - const filePath = path + item; - const isDir = fs.lstatSync(filePath).isDirectory(); - if (isDir) { - dirs.push(filePath); - } else { - files.push(filePath); - } - }); - - const secondFiles = []; - for (let i = 0; i < dirs.length; i++) { - const filePath = dirs[i]; - if (fs.lstatSync(filePath).isDirectory()) { - const sfiles = await readdir(filePath); - const sfilesPath = sfiles.map((c) => { - return filePath + '/' + c; - }); - secondFiles.push(...sfilesPath); - } - } - return [...files, ...secondFiles]; -}; - -const translateFile = async (content) => { try { - const res = await translate(content.toString(), { from: 'en', to: 'zh-CN' }).catch((error) => { - return { text: '' }; + const all = await readdir(path); + const dirs = []; + const files = []; + + all.forEach((item) => { + const filePath = path + item; + const isDir = fs.lstatSync(filePath).isDirectory(); + if (isDir) { + dirs.push(filePath); + } else { + files.push(filePath); + } }); - return res; + + const secondFiles = []; + for (let i = 0; i < dirs.length; i++) { + const filePath = dirs[i]; + if (fs.lstatSync(filePath).isDirectory()) { + const sfiles = await readdir(filePath); + const sfilesPath = sfiles.map((c) => { + return filePath + '/' + c; + }); + secondFiles.push(...sfilesPath); + } + } + return [...files, ...secondFiles]; } catch (error) { - return { - text: '', - }; + return []; } }; + +const TEMP_DOC_FILE_PATH = 'docs/_apis/'; const DOC_FILE_PATH = 'docs/apis/'; + +let errorMessage = ``; + const main = async () => { - const dirPath = DOC_FILE_PATH; + // if node.js version not equal 18 ,throw error + + const RawFiles = await Readdir(TEMP_DOC_FILE_PATH, { recursive: true }); // const files = await readdir(dirPath, { recursive: true }); // it is a bug: https://github.com/nodejs/node/issues/48858 - const AllFiles = await Readdir(dirPath, { recursive: true }); + const AllFiles = await Readdir(DOC_FILE_PATH, { recursive: true }); - const files = AllFiles.filter((item) => { - return item.indexOf('.zh-CN.md') === -1; - }); + for (let i = 0; i < RawFiles.length; i++) { + let file = AllFiles[i]; + let rawFile = RawFiles[i]; + + const en_path = rawFile.replace('.md', '.en.md').replace(TEMP_DOC_FILE_PATH, DOC_FILE_PATH); + const zh_path = rawFile.replace('.md', '.zh.md').replace(TEMP_DOC_FILE_PATH, DOC_FILE_PATH); + let has_en_file = false; + let has_zh_file = false; + + try { + has_en_file = fs.lstatSync(en_path).isFile(); + has_zh_file = fs.lstatSync(zh_path).isFile(); + } catch (error) { + errorMessage = errorMessage + '\n' + error; + } + + if (has_en_file && has_zh_file) { + errorMessage = errorMessage + '\n' + `file: ${file} has been translated`; + console.log(`file: ${file} has been translated`); + continue; + } + + const content = await readFile(rawFile); + + const en_content = content.toString().replaceAll('.md', '.en.md'); + const zh_content = content.toString().replaceAll('.md', '.zh.md'); + + /** create en_US file */ + + await fsExtra.ensureFile(en_path); + await writeFile(en_path, en_content); - for (let i = 0; i < files.length; i++) { - let file = files[i]; - const content = await readFile(file); - const suffix = file.replace('.md', '.zh-CN.md'); let hasTranslated = false; try { - hasTranslated = fs.lstatSync(suffix).isFile(); + hasTranslated = fs.lstatSync(zh_path).isFile(); } catch (error) {} if (!hasTranslated) { - console.log('hasTranslated', hasTranslated, file); - const res = await translateFile(content); - writeFile(suffix, res.text); + const res = await translate(zh_content, { from: 'en', to: 'zh-CN' }).catch((error) => { + errorMessage = errorMessage + '\n' + `TRANSLATE ERROR: ${file}:${zh_path} \n `; + return { text: '' }; + }); + writeFile(zh_path, res.text); } } + fs.writeFileSync('.translate-info.txt', errorMessage); }; main(); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 7a73d9f5b8..015b635622 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -263,6 +263,12 @@ importers: dumi: specifier: ^2.2.4 version: 2.2.4(@babel/core@7.22.10)(@types/node@20.4.7)(eslint@7.22.0)(jest@28.1.3)(postcss@8.4.28)(prettier@2.8.8)(react-dom@16.14.0)(react@16.14.0)(rollup@2.33.3)(styled-components@6.0.7)(stylelint@14.16.1)(stylus@0.54.8)(typescript@4.6.3)(webpack@5.88.2) + fs-extra: + specifier: latest + version: 11.1.1 + google-translate-api-x: + specifier: ^10.6.7 + version: 10.6.7 insert-css: specifier: ^2.0.0 version: 2.0.0 @@ -23511,6 +23517,11 @@ packages: delegate: 3.2.0 optional: true + /google-translate-api-x@10.6.7: + resolution: {integrity: sha512-xw20Kjv5u84Q3FwKTk4CU1PZrYoOsRcKq0z7J3a98aIcscOCZnW3T43Rb/SOl/JPUj/QYyjJiRW9G+MQhxUnAw==} + engines: {node: '>=14.0.0'} + dev: false + /gopd@1.0.1: resolution: {integrity: sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==} dependencies: