ahri-cloud-projects/X6
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: 📚️ fix docs error (#1695)

Browse Source
This commit is contained in:
vector
2021-12-28 23:08:24 +08:00
committed by GitHub
parent 9e0665555d
commit f18ab7c736
2 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
sites/x6-sites/docs/api/model/edge.en.md
View File

@ -452,7 +452,7 @@ disconnect(options?: Edge.SetOptions)
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|---------|:----:|---------|------------------------------------------------------------------------------|
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:source'` 和 `'change:target'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:source'` 和 `'change:target'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
### 路径点 Vertice
@ -481,7 +481,7 @@ setVertices(
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|--------------------------------------|:----:|---------|-----------------------------------------------------------|
| vertices | Point.PointLike \| Point.PointLike[] | ✓ | | 路径点。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:vertices'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:vertices'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### insertVertex(...)
@ -502,7 +502,7 @@ insertVertex(
|------------------|-----------------|:----:|---------|-----------------------------------------------------------|
| vertice | Point.PointLike | ✓ | | 路径点。 |
| index | number | | | 插入位置，默认插入到路径点数组的末尾。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:vertices'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:vertices'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
@ -519,7 +519,7 @@ appendVertex(vertex: Point.PointLike, options?: Edge.SetOptions): this
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|-----------------|:----:|---------|-----------------------------------------------------------|
| vertex | Point.PointLike | ✓ | | 路径点。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:vertices'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:vertices'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### getVertexAt(...)
@ -554,7 +554,7 @@ setVertexAt(
|------------------|-----------------|:----:|---------|-----------------------------------------------------------|
| index | number | ✓ | | 索引位置。 |
| vertice | Point.PointLike | ✓ | | 路径点。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:vertices'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:vertices'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### removeVertexAt(...)
@ -570,7 +570,7 @@ removeVertexAt(index: number, options?: Edge.SetOptions): this
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|---------|:----:|---------|-----------------------------------------------------------|
| index | number | ✓ | | 索引位置。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:vertices'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:vertices'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
### 路由 Router
@ -599,7 +599,7 @@ setRouter(router: Edge.RouterData, options?: Edge.SetOptions): this
| name | string | ✓ | | 路由名称。 |
| args | KeyValue | | | 路由参数。 |
| router | Edge.RouterData | ✓ | | 路由。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:router'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:router'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### removeRouter(...)
@ -614,7 +614,7 @@ removeRouter(options?: Edge.SetOptions): this
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|---------|:----:|---------|---------------------------------------------------------|
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:router'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:router'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
### 连接器 Connector
@ -643,7 +643,7 @@ setConnector(connector: Edge.ConnectorData, options?: Edge.SetOptions): this
| name | string | ✓ | | 连接器名称。 |
| args | KeyValue | | | 连接器参数。 |
| connector | Edge.ConnectorData | ✓ | | 连接器。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:connector'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:connector'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### removeConnector(...)
@ -658,7 +658,7 @@ removeConnector(options?: Edge.SetOptions): this
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|---------|:----:|---------|------------------------------------------------------------|
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:connector'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:connector'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
### 标签 Label
@ -695,7 +695,7 @@ setLabels(
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|--------------------------------------------------|:----:|---------|---------------------------------------------------------|
| labels | Edge.Label \| Edge.Label[] \| string \| string[] | ✓ | | 标签或标签数组。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:labels'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:labels'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### insertLabel(...)
@ -716,7 +716,7 @@ insertLabel(
|------------------|----------------------|:----:|---------|---------------------------------------------------------|
| label | Edge.Label \| string | ✓ | | 标签。 |
| index | number | | | 插入的位置，缺省时插入到标签数组的末尾。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:labels'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:labels'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### appendLabel(...)
@ -732,7 +732,7 @@ appendLabel(label: Edge.Label | string, options?: Edge.SetOptions): this
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|----------------------|:----:|---------|---------------------------------------------------------|
| label | Edge.Label \| string | ✓ | | 标签。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:labels'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:labels'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### getLabelAt(...)
@ -767,7 +767,7 @@ setLabelAt(
|------------------|----------------------|:----:|---------|---------------------------------------------------------|
| index | number | ✓ | | 索引位置。 |
| label | Edge.Label \| string | ✓ | | 标签。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:labels'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:labels'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### removeLabelAt(...)
@ -783,5 +783,5 @@ removeLabelAt(index: number, options?: Edge.SetOptions): this
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|---------|:----:|---------|---------------------------------------------------------|
| index | number | ✓ | | 索引位置。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:labels'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:labels'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |

30
sites/x6-sites/docs/api/model/edge.zh.md
View File

@ -452,7 +452,7 @@ disconnect(options?: Edge.SetOptions)
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|---------|:----:|---------|------------------------------------------------------------------------------|
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:source'` 和 `'change:target'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:source'` 和 `'change:target'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
### 路径点 Vertice
@ -481,7 +481,7 @@ setVertices(
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|--------------------------------------|:----:|---------|-----------------------------------------------------------|
| vertices | Point.PointLike \| Point.PointLike[] | ✓ | | 路径点。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:vertices'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:vertices'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### insertVertex(...)
@ -502,7 +502,7 @@ insertVertex(
|------------------|-----------------|:----:|---------|-----------------------------------------------------------|
| vertice | Point.PointLike | ✓ | | 路径点。 |
| index | number | | | 插入位置，默认插入到路径点数组的末尾。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:vertices'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:vertices'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
@ -519,7 +519,7 @@ appendVertex(vertex: Point.PointLike, options?: Edge.SetOptions): this
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|-----------------|:----:|---------|-----------------------------------------------------------|
| vertex | Point.PointLike | ✓ | | 路径点。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:vertices'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:vertices'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### getVertexAt(...)
@ -554,7 +554,7 @@ setVertexAt(
|------------------|-----------------|:----:|---------|-----------------------------------------------------------|
| index | number | ✓ | | 索引位置。 |
| vertice | Point.PointLike | ✓ | | 路径点。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:vertices'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:vertices'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### removeVertexAt(...)
@ -570,7 +570,7 @@ removeVertexAt(index: number, options?: Edge.SetOptions): this
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|---------|:----:|---------|-----------------------------------------------------------|
| index | number | ✓ | | 索引位置。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:vertices'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:vertices'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
### 路由 Router
@ -599,7 +599,7 @@ setRouter(router: Edge.RouterData, options?: Edge.SetOptions): this
| name | string | ✓ | | 路由名称。 |
| args | KeyValue | | | 路由参数。 |
| router | Edge.RouterData | ✓ | | 路由。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:router'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:router'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### removeRouter(...)
@ -614,7 +614,7 @@ removeRouter(options?: Edge.SetOptions): this
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|---------|:----:|---------|---------------------------------------------------------|
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:router'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:router'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
### 连接器 Connector
@ -643,7 +643,7 @@ setConnector(connector: Edge.ConnectorData, options?: Edge.SetOptions): this
| name | string | ✓ | | 连接器名称。 |
| args | KeyValue | | | 连接器参数。 |
| connector | Edge.ConnectorData | ✓ | | 连接器。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:connector'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:connector'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### removeConnector(...)
@ -658,7 +658,7 @@ removeConnector(options?: Edge.SetOptions): this
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|---------|:----:|---------|------------------------------------------------------------|
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:connector'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:connector'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
### 标签 Label
@ -695,7 +695,7 @@ setLabels(
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|--------------------------------------------------|:----:|---------|---------------------------------------------------------|
| labels | Edge.Label \| Edge.Label[] \| string \| string[] | ✓ | | 标签或标签数组。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:labels'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:labels'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### insertLabel(...)
@ -716,7 +716,7 @@ insertLabel(
|------------------|----------------------|:----:|---------|---------------------------------------------------------|
| label | Edge.Label \| string | ✓ | | 标签。 |
| index | number | | | 插入的位置，缺省时插入到标签数组的末尾。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:labels'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:labels'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### appendLabel(...)
@ -732,7 +732,7 @@ appendLabel(label: Edge.Label | string, options?: Edge.SetOptions): this
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|----------------------|:----:|---------|---------------------------------------------------------|
| label | Edge.Label \| string | ✓ | | 标签。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:labels'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:labels'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### getLabelAt(...)
@ -767,7 +767,7 @@ setLabelAt(
|------------------|----------------------|:----:|---------|---------------------------------------------------------|
| index | number | ✓ | | 索引位置。 |
| label | Edge.Label \| string | ✓ | | 标签。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:labels'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:labels'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |
#### removeLabelAt(...)
@ -783,5 +783,5 @@ removeLabelAt(index: number, options?: Edge.SetOptions): this
| 名称 | 类型 | 必选 | 默认值 | 描述 |
|------------------|---------|:----:|---------|---------------------------------------------------------|
| index | number | ✓ | | 索引位置。 |
| options.silent | boolean | | `false` | 为 `true` 时不触不触发 `'change:labels'` 事件和画布重绘。 |
| options.silent | boolean | | `false` | 为 `true` 时不触发 `'change:labels'` 事件和画布重绘。 |
| options...others | object | | | 其他自定义键值对，可以在事件回调中使用。 |