test/g6
1
0
Fork 0
mirror of https://gitee.com/antv/g6.git synced 2024-12-02 11:48:29 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

V5 locale (#4870)

Browse Source 
* feat: fix locale

* feat: update api doc
This commit is contained in:
pomelo 2023-08-29 05:39:28 -05:00 committed by GitHub
parent c9548251ff
commit 1eda86a093
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
49 changed files with 2299 additions and 988 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/g6/package.json
View File

@ -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",

3
packages/g6/typedoc.config.js
View File

@ -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 */

2
packages/site/.dumirc.ts
View File

@ -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',
},

4
packages/site/.gitignore vendored
View File

@ -8,3 +8,7 @@
.dumi/tmp
.dumi/tmp-production
.DS_Store
## api doc
docs/_apis
.translate-info.txt

10
packages/site/docs/apis/README.md → packages/site/docs/apis/README.en.md
View File

@ -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)

51
packages/site/docs/apis/README.zh.md Normal file
View File

@ -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)

520
packages/site/docs/apis/classes/graph-Graph.md → packages/site/docs/apis/classes/graph-Graph.en.md
View File

File diff suppressed because it is too large Load Diff

0
packages/site/docs/apis/classes/graph-Graph.zh.md Normal file
View File

22
packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.md → packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.en.md
View File

@ -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)

99
packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.zh.md Normal file
View File

@ -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)

28
packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.md → packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.en.md
View File

@ -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)

215
packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.zh.md Normal file
View File

@ -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)

26
packages/site/docs/apis/interfaces/plugins-LegendConfig.md → packages/site/docs/apis/interfaces/plugins-LegendConfig.en.md
View File

@ -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)

123
packages/site/docs/apis/interfaces/plugins-LegendConfig.zh.md Normal file
View File

@ -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)

26
packages/site/docs/apis/interfaces/plugins-MiniMapConfig.md → packages/site/docs/apis/interfaces/plugins-MiniMapConfig.en.md
View File

@ -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)

123
packages/site/docs/apis/interfaces/plugins-MiniMapConfig.zh.md Normal file
View File

@ -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)

30
packages/site/docs/apis/interfaces/plugins-ToolbarConfig.md → packages/site/docs/apis/interfaces/plugins-ToolbarConfig.en.md
View File

@ -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)

134
packages/site/docs/apis/interfaces/plugins-ToolbarConfig.zh.md Normal file
View File

@ -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)

36
packages/site/docs/apis/interfaces/plugins-TooltipConfig.md → packages/site/docs/apis/interfaces/plugins-TooltipConfig.en.md
View File

@ -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)

161
packages/site/docs/apis/interfaces/plugins-TooltipConfig.zh.md Normal file
View File

@ -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)

35
packages/site/docs/apis/interfaces/types-GraphData.en.md Normal file
View File

@ -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)

35
packages/site/docs/apis/interfaces/types-GraphData.md
View File

@ -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)

35
packages/site/docs/apis/interfaces/types-GraphData.zh.md Normal file
View File

@ -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)

14
packages/site/docs/apis/interfaces/types-IG6GraphEvent.md → packages/site/docs/apis/interfaces/types-IG6GraphEvent.en.md
View File

@ -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)

53
packages/site/docs/apis/interfaces/types-IG6GraphEvent.zh.md Normal file
View File

@ -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)

330
packages/site/docs/apis/interfaces/types-IGraph.md → packages/site/docs/apis/interfaces/types-IGraph.en.md
View File

File diff suppressed because it is too large Load Diff

0
packages/site/docs/apis/interfaces/types-IGraph.zh.md Normal file
View File

22
packages/site/docs/apis/interfaces/types-NodeEncode.md → packages/site/docs/apis/interfaces/types-NodeEncode.en.md
View File

@ -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)

133
packages/site/docs/apis/interfaces/types-NodeEncode.zh.md Normal file
View File

@ -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)

304
packages/site/docs/apis/interfaces/types-Specification.en.md Normal file
View File

@ -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<B, T\>
[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)

304
packages/site/docs/apis/interfaces/types-Specification.md
View File

@ -1,304 +0,0 @@
[Overview - v5.0.0-alpha.9](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / Specification
# Interface: Specification<B, T\>
[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)

0
packages/site/docs/apis/interfaces/types-Specification.zh.md Normal file
View File

11
packages/site/docs/apis/modules.en.md Normal file
View File

@ -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)

11
packages/site/docs/apis/modules.md
View File

@ -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)

11
packages/site/docs/apis/modules.zh.md Normal file
View File

@ -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)

6
packages/site/docs/apis/modules/behaviors.md → packages/site/docs/apis/modules/behaviors.en.md
View File

@ -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)

8
packages/site/docs/apis/modules/behaviors.zh.md Normal file
View File

@ -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)

8
packages/site/docs/apis/modules/graph.md → packages/site/docs/apis/modules/graph.en.md
View File

@ -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` | <B1, B2, T1, T2\>(`GraphClass`: typeof [`Graph`](../classes/graph-Graph.md), `extendLibrary`: { `behaviors?`: `B1` ; `edges?`: `any` ; `nodes?`: `any` ; `themeSolvers?`: `T1` }) => typeof [`Graph`](../classes/graph-Graph.md) |
| `extend` | <B1, B2, T1, T2\>(`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<any\> |
| `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)

25
packages/site/docs/apis/modules/graph.zh.md Normal file
View File

@ -0,0 +1,25 @@
[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / 图
# 模块：图
## 课程
- [图](../classes/graph-Graph.zh.md)
## 变量
### 实用程序
• `Const` **Util**：`对象`
#### 类型声明
| 名称 | 类型 |
| :------ | :------ |
| `扩展` | <B1, B2, T1, T2\>(`GraphClass`: typeof [`Graph`](../classes/graph-Graph.zh.md), `extendLibrary`: { `行为？`: `B1` ; `边？`：`任何`；`节点？`：`任何`；`themeSolvers？`：`T1` }) => typeof [`Graph`](../classes/graph-Graph.zh.md) |
| `isEncode` | (`value`: `any`) => 值为 Encode<any\> |
| `模拟` | (`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)

10
packages/site/docs/apis/modules/plugins.en.md Normal file
View File

@ -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)

10
packages/site/docs/apis/modules/plugins.md
View File

@ -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)

10
packages/site/docs/apis/modules/plugins.zh.md Normal file
View File

@ -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)

54
packages/site/docs/apis/modules/types.md → packages/site/docs/apis/modules/types.en.md
View File

@ -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)

0
packages/site/docs/apis/modules/types.zh.md Normal file
View File

14
packages/site/docs/apis/modules/util.md → packages/site/docs/apis/modules/util.en.md
View File

@ -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<any\>
#### 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)

90
packages/site/docs/apis/modules/util.zh.md Normal file
View File

@ -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<any\>
＃＃＃＃ 参数
| 名称 | 类型 |
| :------ | :------ |
| `价值` | `任何` |
#### 返回
值为 Encode<any\>
#### 定义于
[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)

3
packages/site/package.json
View File

@ -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",

77
packages/site/translate-api-doc.mjs
View File

@ -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,6 +9,7 @@ import { readFile, readdir, writeFile } from 'node:fs/promises';
* see : https://github.com/nodejs/node/issues/48858
*/
const Readdir = async (path, options) => {
try {
const all = await readdir(path);
const dirs = [];
const files = [];
@ -35,45 +36,69 @@ const Readdir = async (path, options) => {
}
}
return [...files, ...secondFiles];
};
const translateFile = async (content) => {
try {
const res = await translate(content.toString(), { from: 'en', to: 'zh-CN' }).catch((error) => {
return { text: '' };
});
return res;
} 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();

11
pnpm-lock.yaml
View File

@ -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: