mirror of
https://gitee.com/antv/g6.git
synced 2024-12-02 19:58:46 +08:00
docs: format docs of behaviors, plugins, shape and common (#5164)
This commit is contained in:
Aaron
GitHub
parent
e08c299a69
commit
ef337861df
@ -16,9 +16,7 @@ Activate the adjacent nodes of the current node when the interaction is triggere
|
||||
|
||||
**Default**: `selected`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Switch to this state when highlighted
|
||||
Switch to this state when highlighted
|
||||
|
||||
<embed src="../../common/BehaviorMultiple.zh.md"></embed>
|
||||
|
||||
@ -26,10 +24,8 @@ Activate the adjacent nodes of the current node when the interaction is triggere
|
||||
|
||||
**Type**: `string`
|
||||
|
||||
**Default**: `click` | `pointerenter`
|
||||
**Default**: `click | pointerenter`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The event type that triggers the interaction
|
||||
The event type that triggers the interaction
|
||||
|
||||
<embed src="../../common/BehaviorShould.en.md"></embed>
|
||||
|
||||
@ -16,9 +16,7 @@ order: 8
|
||||
|
||||
**默认值**：`selected`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：高亮时切换到该状态
|
||||
高亮时切换到该状态
|
||||
|
||||
<embed src="../../common/BehaviorMultiple.zh.md"></embed>
|
||||
|
||||
@ -26,10 +24,8 @@ order: 8
|
||||
|
||||
**类型**：`string`
|
||||
|
||||
**默认值**：`click` | `pointerenter`
|
||||
**默认值**：`click | pointerenter`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：触发交互的事件类型
|
||||
触发交互的事件类型
|
||||
|
||||
<embed src="../../common/BehaviorShould.zh.md"></embed>
|
||||
|
||||
@ -10,5 +10,3 @@ Brush select a group of nodes
|
||||
<img alt="brush select" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*sa3jRqp83K4AAAAAAAAAAAAADmJ7AQ/original" height='300'/>
|
||||
|
||||
<embed src="../../common/BehaviorBrushSelect.en.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
@ -10,5 +10,3 @@ order: 5
|
||||
<img alt="brush select" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*sa3jRqp83K4AAAAAAAAAAAAADmJ7AQ/original" height='300'/>
|
||||
|
||||
<embed src="../../common/BehaviorBrushSelect.zh.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
|
||||
@ -19,18 +19,14 @@ order: 4
|
||||
|
||||
**Default**: `selected`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Switch to this state when selected
|
||||
Switch to this state when selected
|
||||
|
||||
## trigger
|
||||
|
||||
**Type**: `'shift'` | `'ctrl'` | `'alt'` | `'control'`
|
||||
**Type**: `'shift' | 'ctrl' | 'alt' | 'control'`
|
||||
|
||||
**Default**: `'shift'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Hold down to select multiple
|
||||
Hold down to select multiple
|
||||
|
||||
<embed src="../../common/BehaviorShould.en.md"></embed>
|
||||
|
||||
@ -19,18 +19,14 @@ order: 4
|
||||
|
||||
**默认值**：`selected`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：选中时切换到该状态
|
||||
选中时切换到该状态
|
||||
|
||||
## trigger
|
||||
|
||||
**类型**：`'shift'` | `'ctrl'` | `'alt'` | `'control'`
|
||||
**类型**：`'shift' | 'ctrl' | 'alt' | 'control'`
|
||||
|
||||
**默认值**：`'shift'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：按住以进行多选
|
||||
按住以进行多选
|
||||
|
||||
<embed src="../../common/BehaviorShould.zh.md"></embed>
|
||||
|
||||
@ -12,14 +12,12 @@ order: 9
|
||||
|
||||
## trigger
|
||||
|
||||
**Type**: `'click'` | `'dblclick'`
|
||||
**Type**: `'click' | 'dblclick'`
|
||||
|
||||
**Default**: `click`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The event that triggers the collapse/expand of the Combo
|
||||
The event that triggers the collapse/expand of the Combo
|
||||
|
||||
<embed src="../../common/BehaviorShouldBegin.en.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
|
||||
@ -12,14 +12,10 @@ order: 9
|
||||
|
||||
## trigger
|
||||
|
||||
**类型**：`'click'` | `'dblclick'`
|
||||
**类型**：`'click' | 'dblclick'`
|
||||
|
||||
**默认值**：`click`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：触发收起/展开 Combo 的事件
|
||||
触发收起/展开 Combo 的事件
|
||||
|
||||
<embed src="../../common/BehaviorShouldBegin.zh.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
|
||||
@ -13,9 +13,7 @@ order: 10
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to disable animation
|
||||
Whether to disable animation
|
||||
|
||||
<embed src="../../common/BehaviorEventName.en.md"></embed>
|
||||
|
||||
@ -23,10 +21,8 @@ order: 10
|
||||
|
||||
## trigger
|
||||
|
||||
**Type**: `'click'` | `'dblclick'`
|
||||
**Type**: `'click' | 'dblclick'`
|
||||
|
||||
**Default**: `click`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The event that triggers the collapse/expand of the tree
|
||||
The event that triggers the collapse/expand of the tree
|
||||
|
||||
@ -13,9 +13,7 @@ order: 10
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否禁用动画
|
||||
是否禁用动画
|
||||
|
||||
<embed src="../../common/BehaviorEventName.zh.md"></embed>
|
||||
|
||||
@ -23,10 +21,8 @@ order: 10
|
||||
|
||||
## trigger
|
||||
|
||||
**类型**：`'click'` | `'dblclick'`
|
||||
**类型**：`'click' | 'dblclick'`
|
||||
|
||||
**默认值**：`click`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：触发收起/展开树的事件
|
||||
触发收起/展开树的事件
|
||||
|
||||
@ -14,9 +14,7 @@ order: 13
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The event name triggered when canceling the creation of the edge
|
||||
The event name triggered when canceling the creation of the edge
|
||||
|
||||
## createActualEventName
|
||||
|
||||
@ -24,9 +22,7 @@ order: 13
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The event name triggered when creating the actual edge
|
||||
The event name triggered when creating the actual edge
|
||||
|
||||
## createVirtualEventName
|
||||
|
||||
@ -34,9 +30,7 @@ order: 13
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The event name triggered when creating the virtual edge
|
||||
The event name triggered when creating the virtual edge
|
||||
|
||||
## edgeConfig
|
||||
|
||||
@ -44,15 +38,13 @@ order: 13
|
||||
|
||||
**Default**: `{}`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Edge configuration
|
||||
Edge configuration
|
||||
|
||||
<embed src="../../common/BehaviorSecondaryKey.en.md"></embed>
|
||||
|
||||
## trigger
|
||||
|
||||
**Type**: `'click'` | `'drag'`
|
||||
**Type**: `'click' | 'drag'`
|
||||
|
||||
<!-- TODO 这里没和Type定义保持一致，需要确认 -->
|
||||
|
||||
|
||||
@ -14,9 +14,7 @@ order: 13
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：取消创建边时，触发的事件名称
|
||||
取消创建边时，触发的事件名称
|
||||
|
||||
## createActualEventName
|
||||
|
||||
@ -24,9 +22,7 @@ order: 13
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：创建真实边时，触发的事件名称
|
||||
创建真实边时，触发的事件名称
|
||||
|
||||
## createVirtualEventName
|
||||
|
||||
@ -34,9 +30,7 @@ order: 13
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：创建虚拟边时，触发的事件名称
|
||||
创建虚拟边时，触发的事件名称
|
||||
|
||||
## edgeConfig
|
||||
|
||||
@ -44,15 +38,13 @@ order: 13
|
||||
|
||||
**默认值**：`{}`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：边的配置项
|
||||
边的配置项
|
||||
|
||||
<embed src="../../common/BehaviorSecondaryKey.zh.md"></embed>
|
||||
|
||||
## trigger
|
||||
|
||||
**类型**：`'click'` | `'drag'`
|
||||
**类型**：`'click' | 'drag'`
|
||||
|
||||
<!-- TODO 这里没和类型定义保持一致，需要确认 -->
|
||||
|
||||
|
||||
@ -17,9 +17,7 @@ order: 1
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to drag the canvas when dragging the node, edge or combo
|
||||
Whether to drag the canvas when dragging the node, edge or combo
|
||||
|
||||
<embed src="../../common/BehaviorDirection.en.md"></embed>
|
||||
|
||||
@ -33,9 +31,7 @@ order: 1
|
||||
|
||||
**Default**: `shift`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The key to disable dragging
|
||||
The key to disable dragging
|
||||
|
||||
<embed src="../../common/BehaviorShouldBegin.en.md"></embed>
|
||||
|
||||
@ -43,12 +39,10 @@ order: 1
|
||||
|
||||
## trigger
|
||||
|
||||
**Type**: `'drag'` | `'directionKeys'`
|
||||
**Type**: `'drag' | 'directionKeys'`
|
||||
|
||||
**Default**: `drag`
|
||||
|
||||
**Required**: false
|
||||
The event type that triggers the interaction
|
||||
|
||||
**Description**: The event type that triggers the interaction
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
@ -17,9 +17,7 @@ order: 1
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否在节点/边/Combo 上触发画布拖拽
|
||||
是否在节点/边/Combo 上触发画布拖拽
|
||||
|
||||
<embed src="../../common/BehaviorDirection.zh.md"></embed>
|
||||
|
||||
@ -33,9 +31,7 @@ order: 1
|
||||
|
||||
**默认值**：`shift`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：禁用拖拽的按键
|
||||
禁用拖拽的按键
|
||||
|
||||
<embed src="../../common/BehaviorShouldBegin.zh.md"></embed>
|
||||
|
||||
@ -43,12 +39,8 @@ order: 1
|
||||
|
||||
## trigger
|
||||
|
||||
**类型**：`'drag'` | `'directionKeys'`
|
||||
**类型**：`'drag' | 'directionKeys'`
|
||||
|
||||
**默认值**：`drag`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：触发交互的事件类型
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
触发交互的事件类型
|
||||
|
||||
@ -12,4 +12,4 @@ order: 3
|
||||
|
||||
<embed src="../../common/BehaviorDrag.en.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
|
||||
@ -11,5 +11,3 @@ order: 3
|
||||
<img alt="drag combo" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*JEWOTbFpm0kAAAAAAAAAAAAADmJ7AQ/original" height='300'/>
|
||||
|
||||
<embed src="../../common/BehaviorDrag.zh.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
|
||||
@ -9,4 +9,4 @@ order: 2
|
||||
|
||||
<embed src="../../common/BehaviorDrag.en.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
|
||||
@ -8,5 +8,3 @@ order: 2
|
||||
<img alt="drag node" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*EQPkQ7bZgCYAAAAAAAAAAAAADmJ7AQ/original" height='300'/>
|
||||
|
||||
<embed src="../../common/BehaviorDrag.zh.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
|
||||
@ -15,9 +15,7 @@ Activate on hover
|
||||
|
||||
**Default**: `'selected'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The state when activated
|
||||
The state when activated
|
||||
|
||||
<embed src="../../common/BehaviorEventName.en.md"></embed>
|
||||
|
||||
@ -27,4 +25,4 @@ Activate on hover
|
||||
|
||||
<embed src="../../common/Throttle.en.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
|
||||
@ -15,9 +15,7 @@ order: 7
|
||||
|
||||
**默认值**：`'selected'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：激活时的状态
|
||||
激活时的状态
|
||||
|
||||
<embed src="../../common/BehaviorEventName.zh.md"></embed>
|
||||
|
||||
@ -26,5 +24,3 @@ order: 7
|
||||
<embed src="../../common/BehaviorShouldBegin.zh.md"></embed>
|
||||
|
||||
<embed src="../../common/Throttle.zh.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
|
||||
@ -11,4 +11,4 @@ Select a group of nodes by lasso.
|
||||
|
||||
<embed src="../../common/BehaviorBrushSelect.en.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
|
||||
@ -10,5 +10,3 @@ order: 6
|
||||
<img alt="lasso select" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*VoOXTLCo6HwAAAAAAAAAAAAADmJ7AQ/original" height='300'/>
|
||||
|
||||
<embed src="../../common/BehaviorBrushSelect.zh.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
|
||||
@ -19,12 +19,10 @@ Fixed focalPoint, change camera position
|
||||
|
||||
## trigger
|
||||
|
||||
**Type**: `'drag'` | `'directionKeys'`
|
||||
**Type**: `'drag' | 'directionKeys'`
|
||||
|
||||
**Default**: `'drag'`
|
||||
|
||||
**Required**: false
|
||||
The way to trigger interaction
|
||||
|
||||
**Description**: The way to trigger interaction
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
@ -19,12 +19,8 @@ order: 14
|
||||
|
||||
## trigger
|
||||
|
||||
**类型**：`'drag'` | `'directionKeys'`
|
||||
**类型**：`'drag' | 'directionKeys'`
|
||||
|
||||
**默认值**：`'drag'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：触发交互的方式
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
触发交互的方式
|
||||
|
||||
@ -8,13 +8,11 @@ order: 12
|
||||
|
||||
## allowDragOnItem
|
||||
|
||||
**Type**: `boolean` | `{node?: boolean; edge?: boolean; combo?: boolean}`
|
||||
**Type**: `boolean | {node?: boolean; edge?: boolean; combo?: boolean}`
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to scroll the canvas when dragging the node, edge or combo
|
||||
Whether to scroll the canvas when dragging the node, edge or combo
|
||||
|
||||
<embed src="../../common/BehaviorDirection.en.md"></embed>
|
||||
|
||||
@ -24,13 +22,11 @@ order: 12
|
||||
|
||||
## zoomKey
|
||||
|
||||
**Type**: `string` | `string[]`
|
||||
**Type**: `string | string[]`
|
||||
|
||||
**Default**: `ctrl`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The key to trigger zooming
|
||||
The key to trigger zooming
|
||||
|
||||
## zoomRatio
|
||||
|
||||
@ -38,6 +34,4 @@ order: 12
|
||||
|
||||
**Default**: `0.05`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The ratio of zooming
|
||||
The ratio of zooming
|
||||
|
||||
@ -8,13 +8,11 @@ order: 12
|
||||
|
||||
## allowDragOnItem
|
||||
|
||||
**类型**：`boolean` | `{node?: boolean; edge?: boolean; combo?: boolean}`
|
||||
**类型**：`boolean | {node?: boolean; edge?: boolean; combo?: boolean}`
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否在节点/边/Combo 上触发画布滚动
|
||||
是否在节点/边/Combo 上触发画布滚动
|
||||
|
||||
<embed src="../../common/BehaviorDirection.zh.md"></embed>
|
||||
|
||||
@ -24,13 +22,11 @@ order: 12
|
||||
|
||||
## zoomKey
|
||||
|
||||
**类型**：`string` | `string[]`
|
||||
**类型**：`string | string[]`
|
||||
|
||||
**默认值**：`ctrl`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：触发缩放的按键
|
||||
触发缩放的按键
|
||||
|
||||
## zoomRatio
|
||||
|
||||
@ -38,6 +34,4 @@ order: 12
|
||||
|
||||
**默认值**：`0.05`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：缩放比例
|
||||
缩放比例
|
||||
|
||||
@ -11,9 +11,7 @@ order: 11
|
||||
|
||||
**Default**: `'1'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: combined key
|
||||
combined key
|
||||
|
||||
## functionName
|
||||
|
||||
@ -21,9 +19,7 @@ order: 11
|
||||
|
||||
**Default**: `'fitView'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: function name
|
||||
function name
|
||||
|
||||
## functionParams
|
||||
|
||||
@ -31,16 +27,12 @@ order: 11
|
||||
|
||||
**Default**: `[]`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: function params
|
||||
function params
|
||||
|
||||
## trigger
|
||||
|
||||
**Type**: `'shift'` | `'ctrl'` | `'alt'` | `'control'`
|
||||
**Type**: `'shift' | 'ctrl' | 'alt' | 'control'`
|
||||
|
||||
**Default**: `'ctrl'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: trigger key
|
||||
trigger key
|
||||
|
||||
@ -11,9 +11,7 @@ order: 11
|
||||
|
||||
**默认值**：`'1'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：组合键
|
||||
组合键
|
||||
|
||||
## functionName
|
||||
|
||||
@ -21,9 +19,7 @@ order: 11
|
||||
|
||||
**默认值**：`'fitView'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：函数名
|
||||
函数名
|
||||
|
||||
## functionParams
|
||||
|
||||
@ -31,16 +27,12 @@ order: 11
|
||||
|
||||
**默认值**：`[]`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：函数参数
|
||||
函数参数
|
||||
|
||||
## trigger
|
||||
|
||||
**类型**：`'shift'` | `'ctrl'` | `'alt'` | `'control'`
|
||||
**类型**：`'shift' | 'ctrl' | 'alt' | 'control'`
|
||||
|
||||
**默认值**：`'ctrl'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：触发快捷键的按键
|
||||
触发快捷键的按键
|
||||
|
||||
@ -17,12 +17,10 @@ Rotate the camera around the graph with a fixed camera position
|
||||
|
||||
## trigger
|
||||
|
||||
**Type**: `'drag'` | `'directionKeys'`
|
||||
**Type**: `'drag' | 'directionKeys'`
|
||||
|
||||
**Default**: `'drag'`
|
||||
|
||||
**Required**: false
|
||||
The way to trigger interaction
|
||||
|
||||
**Description**: The way to trigger interaction
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
@ -17,12 +17,8 @@ order: 15
|
||||
|
||||
## trigger
|
||||
|
||||
**类型**：`'drag'` | `'directionKeys'`
|
||||
**类型**：`'drag' | 'directionKeys'`
|
||||
|
||||
**默认值**：`'drag'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：触发交互的方式
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
触发交互的方式
|
||||
|
||||
@ -9,6 +9,6 @@ Zoom canvas in 3D scene
|
||||
|
||||
<img alt="3d zoom canvas" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*hWoCRY_2i50AAAAAAAAAAAAADmJ7AQ/original" height='300'/>
|
||||
|
||||
<embed src="../../common/BaseZoonCanvasOptions.en.md"></embed>
|
||||
<embed src="../../common/BaseZoomCanvasOptions.en.md"></embed>
|
||||
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
@ -9,6 +9,4 @@ order: 16
|
||||
|
||||
<img alt="3d zoom canvas" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*hWoCRY_2i50AAAAAAAAAAAAADmJ7AQ/original" height='300'/>
|
||||
|
||||
<embed src="../../common/BaseZoonCanvasOptions.zh.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
<embed src="../../common/BaseZoomCanvasOptions.zh.md"></embed>
|
||||
|
||||
@ -11,8 +11,8 @@ Zoom canvas
|
||||
|
||||
<embed src="../../common/BehaviorEnableOptimize.en.md"></embed>
|
||||
|
||||
<embed src="../../common/BaseZoonCanvasOptions.en.md"></embed>
|
||||
<embed src="../../common/BaseZoomCanvasOptions.en.md"></embed>
|
||||
|
||||
<embed src="../../common/BehaviorSpeedUpKey.en.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
|
||||
@ -11,8 +11,6 @@ order: 0
|
||||
|
||||
<embed src="../../common/BehaviorEnableOptimize.zh.md"></embed>
|
||||
|
||||
<embed src="../../common/BaseZoonCanvasOptions.zh.md"></embed>
|
||||
<embed src="../../common/BaseZoomCanvasOptions.zh.md"></embed>
|
||||
|
||||
<embed src="../../common/BehaviorSpeedUpKey.zh.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
|
||||
@ -17,13 +17,11 @@ Filter out edges that do not exist on one side of the filter
|
||||
|
||||
### showType
|
||||
|
||||
**Type**: `'one'` | `'both'` | `'only-source'` | `'only-target'`
|
||||
**Type**: `'one' | 'both' | 'only-source' | 'only-target'`
|
||||
|
||||
**Default**: `'both`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The type of edge to display
|
||||
The type of edge to display
|
||||
|
||||
- `'one'`: Display edges that are at least one side in the filter
|
||||
- `'both'`: Display edges that are both ends in the filter
|
||||
@ -36,9 +34,7 @@ Filter out edges that do not exist on one side of the filter
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to display the edge callback function
|
||||
Whether to display the edge callback function
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@ -17,13 +17,11 @@ order: 10
|
||||
|
||||
### showType
|
||||
|
||||
**类型**：`'one'` | `'both'` | `'only-source'` | `'only-target'`
|
||||
**类型**：`'one' | 'both' | 'only-source' | 'only-target'`
|
||||
|
||||
**默认值**：`'both`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：显示的边类型
|
||||
显示的边类型
|
||||
|
||||
- `'one'`：显示至少有一端在滤镜内的边
|
||||
- `'both'`：显示两端都在滤镜内的边
|
||||
@ -36,9 +34,7 @@ order: 10
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否显示边的回调函数
|
||||
是否显示边的回调函数
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@ -20,9 +20,7 @@ Zoom in on objects in the lens
|
||||
|
||||
**Default**: `1.5`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The magnification of the fisheye
|
||||
The magnification of the fisheye
|
||||
|
||||
### maxD
|
||||
|
||||
@ -30,9 +28,7 @@ Zoom in on objects in the lens
|
||||
|
||||
**Default**: `5`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The maximum value of the magnification of the fisheye
|
||||
The maximum value of the magnification of the fisheye
|
||||
|
||||
### minD
|
||||
|
||||
@ -40,19 +36,15 @@ Zoom in on objects in the lens
|
||||
|
||||
**Default**: `1`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The minimum value of the magnification of the fisheye
|
||||
The minimum value of the magnification of the fisheye
|
||||
|
||||
### scaleDBy
|
||||
|
||||
**Type**: `'wheel'` | `'drag'` | `'unset'`
|
||||
**Type**: `'wheel' | 'drag' | 'unset'`
|
||||
|
||||
**Default**: `'drag'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The way to scale the magnification of the fisheye
|
||||
The way to scale the magnification of the fisheye
|
||||
|
||||
> In the fisheye, the magnification of the fisheye is scaled by mouse wheel or drag
|
||||
|
||||
@ -62,9 +54,7 @@ Zoom in on objects in the lens
|
||||
|
||||
**Default**: `true`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to show the percentage of the magnification (`d`) of the fisheye
|
||||
Whether to show the percentage of the magnification (`d`) of the fisheye
|
||||
|
||||
<embed src="../../common/Throttle.en.md"></embed>
|
||||
|
||||
|
||||
@ -20,9 +20,7 @@ order: 11
|
||||
|
||||
**默认值**：`1.5`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：鱼眼放大倍率
|
||||
鱼眼放大倍率
|
||||
|
||||
### maxD
|
||||
|
||||
@ -30,9 +28,7 @@ order: 11
|
||||
|
||||
**默认值**：`5`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：鱼眼放大倍数的最大值
|
||||
鱼眼放大倍数的最大值
|
||||
|
||||
### minD
|
||||
|
||||
@ -40,19 +36,15 @@ order: 11
|
||||
|
||||
**默认值**：`1`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：鱼眼放大倍数的最小值
|
||||
鱼眼放大倍数的最小值
|
||||
|
||||
### scaleDBy
|
||||
|
||||
**类型**：`'wheel'` | `'drag'` | `'unset'`
|
||||
**类型**：`'wheel' | 'drag' | 'unset'`
|
||||
|
||||
**默认值**：`'drag'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：鱼眼放大倍数的缩放方式
|
||||
鱼眼放大倍数的缩放方式
|
||||
|
||||
> 即在鱼眼中通过鼠标滚轮或者拖拽来缩放鱼眼放大倍数
|
||||
|
||||
@ -62,9 +54,7 @@ order: 11
|
||||
|
||||
**默认值**：`true`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否展示鱼眼区域内对象的放大倍率(`d`)
|
||||
是否展示鱼眼区域内对象的放大倍率(`d`)
|
||||
|
||||
<embed src="../../common/Throttle.zh.md"></embed>
|
||||
|
||||
|
||||
@ -17,9 +17,7 @@ order: 2
|
||||
|
||||
**Default**: `''`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Background image of grid
|
||||
Background image of grid
|
||||
|
||||
### follow
|
||||
|
||||
@ -27,9 +25,7 @@ order: 2
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to follow the canvas movement
|
||||
Whether to follow the canvas movement
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@ -17,9 +17,7 @@ order: 2
|
||||
|
||||
**默认值**：`''`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：网格线背景图片
|
||||
网格线背景图片
|
||||
|
||||
### follow
|
||||
|
||||
@ -27,9 +25,7 @@ order: 2
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否跟随画布移动
|
||||
是否跟随画布移动
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@ -13,19 +13,17 @@ order: 1
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
Whether to enable stack
|
||||
|
||||
**Description**: Whether to enable stack
|
||||
|
||||
### stackCfg
|
||||
### stackCfg <Badge type="error">Required</Badge>
|
||||
|
||||
**Type**: `StackCfg`
|
||||
|
||||
<embed src="../../common/StackCfg.en.md"></embed>
|
||||
|
||||
**Default**: `{}`
|
||||
|
||||
**Required**: true
|
||||
|
||||
**Description**: Stack configuration
|
||||
Stack configuration
|
||||
|
||||
## API
|
||||
|
||||
@ -69,18 +67,24 @@ order: 1
|
||||
|
||||
**Type**: `() => Record<string, Command[][]>;`
|
||||
|
||||
<embed src="../../common/PluginHistoryCommand.en.md"></embed>
|
||||
|
||||
**Description**: Get stack
|
||||
|
||||
### getRedoStack
|
||||
|
||||
**Type**: `() => Command[][];`
|
||||
|
||||
<embed src="../../common/PluginHistoryCommand.en.md"></embed>
|
||||
|
||||
**Description**: Get redo stack
|
||||
|
||||
### getUndoStack
|
||||
|
||||
**Type**: `() => Command[][];`
|
||||
|
||||
<embed src="../../common/PluginHistoryCommand.en.md"></embed>
|
||||
|
||||
**Description**: Get undo stack
|
||||
|
||||
### historyBatch
|
||||
@ -97,6 +101,19 @@ order: 1
|
||||
|
||||
**Type**: `(commands: Command[], stackType: StackType = 'undo', isNew = true) => void;`
|
||||
|
||||
<embed src="../../common/PluginHistoryCommand.en.md"></embed>
|
||||
|
||||
<details>
|
||||
<summary style="color: #873bf4; cursor: pointer;">
|
||||
StackType
|
||||
</summary>
|
||||
|
||||
```ts
|
||||
type StackType = 'redo' | 'undo';
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
**Description**: Push stack
|
||||
|
||||
**Description**: Notify event
|
||||
@ -126,16 +143,3 @@ order: 1
|
||||
**Description**: Stop history batch
|
||||
|
||||
<embed src="../../common/PluginAPIDestroy.en.md"></embed>
|
||||
|
||||
---
|
||||
|
||||
```ts
|
||||
type StackType = 'redo' | 'undo';
|
||||
|
||||
type Command = {
|
||||
redo: (graph: IGraph) => void;
|
||||
undo: (graph: IGraph) => void;
|
||||
};
|
||||
```
|
||||
|
||||
<embed src="../../common/StackCfg.en.md"></embed>
|
||||
|
||||
@ -13,19 +13,17 @@ order: 1
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
是否启用堆栈
|
||||
|
||||
**说明**：是否启用堆栈
|
||||
|
||||
### stackCfg
|
||||
### stackCfg <Badge type="error">必须</Badge>
|
||||
|
||||
**类型**：`StackCfg`
|
||||
|
||||
<embed src="../../common/StackCfg.zh.md"></embed>
|
||||
|
||||
**默认值**：`{}`
|
||||
|
||||
**是否必须**：true
|
||||
|
||||
**说明**：堆栈配置
|
||||
堆栈配置
|
||||
|
||||
## API
|
||||
|
||||
@ -69,18 +67,24 @@ order: 1
|
||||
|
||||
**类型**：`() => Record<string, Command[][]>;`
|
||||
|
||||
<embed src="../../common/PluginHistoryCommand.zh.md"></embed>
|
||||
|
||||
**说明**：获取堆栈
|
||||
|
||||
### getRedoStack
|
||||
|
||||
**类型**：`() => Command[][];`
|
||||
|
||||
<embed src="../../common/PluginHistoryCommand.zh.md"></embed>
|
||||
|
||||
**说明**：获取重做堆栈
|
||||
|
||||
### getUndoStack
|
||||
|
||||
**类型**：`() => Command[][];`
|
||||
|
||||
<embed src="../../common/PluginHistoryCommand.zh.md"></embed>
|
||||
|
||||
**说明**：获取撤销堆栈
|
||||
|
||||
### historyBatch
|
||||
@ -99,6 +103,19 @@ order: 1
|
||||
|
||||
**类型**：`(commands: Command[], stackType: StackType = 'undo', isNew = true) => void;`
|
||||
|
||||
<embed src="../../common/PluginHistoryCommand.zh.md"></embed>
|
||||
|
||||
<details>
|
||||
<summary style="color: #873bf4; cursor: pointer;">
|
||||
StackType
|
||||
</summary>
|
||||
|
||||
```ts
|
||||
type StackType = 'redo' | 'undo';
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
**说明**：推入堆栈
|
||||
|
||||
### redo
|
||||
@ -126,16 +143,3 @@ order: 1
|
||||
**说明**：结束历史批处理
|
||||
|
||||
<embed src="../../common/PluginAPIDestroy.zh.md"></embed>
|
||||
|
||||
---
|
||||
|
||||
```ts
|
||||
type StackType = 'redo' | 'undo';
|
||||
|
||||
type Command = {
|
||||
redo: (graph: IGraph) => void;
|
||||
undo: (graph: IGraph) => void;
|
||||
};
|
||||
```
|
||||
|
||||
<embed src="../../common/StackCfg.zh.md"></embed>
|
||||
|
||||
@ -20,9 +20,7 @@ Add a hull to a group of objects for wrapping
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: More detailed configuration of the wrapped properties
|
||||
More detailed configuration of the wrapped properties
|
||||
|
||||
> Usually, you don't need to configure this property
|
||||
|
||||
@ -32,9 +30,7 @@ Add a hull to a group of objects for wrapping
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Enabled hull wrapping
|
||||
Enabled hull wrapping
|
||||
|
||||
> You can also add, remove, and update hulls through the API
|
||||
|
||||
@ -63,9 +59,7 @@ type labelShape = ShapeSyle & {
|
||||
|
||||
**Default**: `10`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The inner padding of the hull
|
||||
The inner padding of the hull
|
||||
|
||||
### style
|
||||
|
||||
@ -73,9 +67,7 @@ type labelShape = ShapeSyle & {
|
||||
|
||||
**Default**: `{}`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Hull style
|
||||
Hull style
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@ -20,9 +20,7 @@ order: 12
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：更精细的配置包裹属性
|
||||
更精细的配置包裹属性
|
||||
|
||||
> 通常情况下，不需要配置该属性
|
||||
|
||||
@ -32,9 +30,7 @@ order: 12
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：启用的轮廓包裹
|
||||
启用的轮廓包裹
|
||||
|
||||
> 也可以通过 API 来添加、移除、更新轮廓包裹
|
||||
|
||||
@ -53,9 +49,7 @@ type labelShape = ShapeSyle & {
|
||||
|
||||
**默认值**：`{}`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：标签样式
|
||||
标签样式
|
||||
|
||||
### padding
|
||||
|
||||
@ -63,9 +57,7 @@ type labelShape = ShapeSyle & {
|
||||
|
||||
**默认值**：`10`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：轮廓包裹的内边距
|
||||
轮廓包裹的内边距
|
||||
|
||||
### style
|
||||
|
||||
@ -73,9 +65,7 @@ type labelShape = ShapeSyle & {
|
||||
|
||||
**默认值**：`{}`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：轮廓样式
|
||||
轮廓样式
|
||||
|
||||
## API
|
||||
|
||||
@ -83,43 +73,43 @@ type labelShape = ShapeSyle & {
|
||||
|
||||
**类型**：`(options: HullComponentOptions | HullComponentOptions[]) => void;`
|
||||
|
||||
**说明**：添加轮廓包裹
|
||||
添加轮廓包裹
|
||||
|
||||
### addHullMember
|
||||
|
||||
**类型**：`(id: ID, member: ID | ID[]) => void;`
|
||||
|
||||
**说明**：添加轮廓包裹成员
|
||||
添加轮廓包裹成员
|
||||
|
||||
### addHullNonMember
|
||||
|
||||
**类型**：`(id: ID, member: ID | ID[]) => void;`
|
||||
|
||||
**说明**：添加轮廓包裹非成员
|
||||
添加轮廓包裹非成员
|
||||
|
||||
### removeHull
|
||||
|
||||
**类型**：`(id: ID[]) => void;`
|
||||
|
||||
**说明**：移除轮廓包裹
|
||||
移除轮廓包裹
|
||||
|
||||
### removeHullMember
|
||||
|
||||
**类型**：`(id: ID, member: ID | ID[]) => void;`
|
||||
|
||||
**说明**：移除轮廓包裹成员
|
||||
移除轮廓包裹成员
|
||||
|
||||
### removeHullNonMember
|
||||
|
||||
**类型**：`(id: ID, member: ID | ID[]) => void;`
|
||||
|
||||
**说明**：移除轮廓包裹非成员
|
||||
移除轮廓包裹非成员
|
||||
|
||||
### updateHull
|
||||
|
||||
**类型**：`(options: HullComponentOptions | HullComponentOptions[]) => void;`
|
||||
|
||||
**说明**：更新轮廓包裹
|
||||
更新轮廓包裹
|
||||
|
||||
<embed src="../../common/PluginAPIDestroy.zh.md"></embed>
|
||||
|
||||
|
||||
@ -19,9 +19,7 @@ order: 3
|
||||
|
||||
**Default**: `'active'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Switch to this state after legend is activated
|
||||
Switch to this state after legend is activated
|
||||
|
||||
### edge
|
||||
|
||||
@ -29,9 +27,7 @@ order: 3
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Edge legend configuration
|
||||
Edge legend configuration
|
||||
|
||||
### inactiveState
|
||||
|
||||
@ -39,9 +35,7 @@ order: 3
|
||||
|
||||
**Default**: `''`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Switch to this state after legend is deactivated
|
||||
Switch to this state after legend is deactivated
|
||||
|
||||
### node
|
||||
|
||||
@ -49,13 +43,11 @@ order: 3
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Node legend configuration
|
||||
Node legend configuration
|
||||
|
||||
### orientation
|
||||
|
||||
**Type**: `'horizontal'` | `'vertical'`
|
||||
**Type**: `'horizontal' | 'vertical'`
|
||||
|
||||
**Default**: `'horizontal'`
|
||||
|
||||
@ -67,13 +59,11 @@ order: 3
|
||||
|
||||
**Default**: `'selected'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Switch to this state after legend is selected
|
||||
Switch to this state after legend is selected
|
||||
|
||||
### size
|
||||
|
||||
**Type**: `'fit-content'` | `[number | string, number | string]`
|
||||
**Type**: `'fit-content' | [number | string, number | string]`
|
||||
|
||||
**Default**: `'fit-content'`
|
||||
|
||||
|
||||
@ -19,9 +19,7 @@ order: 3
|
||||
|
||||
**默认值**：`'active'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图例激活后切换到该状态
|
||||
图例激活后切换到该状态
|
||||
|
||||
### edge
|
||||
|
||||
@ -29,9 +27,7 @@ order: 3
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：边图例配置
|
||||
边图例配置
|
||||
|
||||
### inactiveState
|
||||
|
||||
@ -39,9 +35,7 @@ order: 3
|
||||
|
||||
**默认值**：`''`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图例取消激活后切换到该状态
|
||||
图例取消激活后切换到该状态
|
||||
|
||||
### node
|
||||
|
||||
@ -49,13 +43,11 @@ order: 3
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：节点图例配置
|
||||
节点图例配置
|
||||
|
||||
### orientation
|
||||
|
||||
**类型**：`'horizontal'` | `'vertical'`
|
||||
**类型**：`'horizontal' | 'vertical'`
|
||||
|
||||
**默认值**：`'horizontal'`
|
||||
|
||||
@ -67,13 +59,11 @@ order: 3
|
||||
|
||||
**默认值**：`'selected'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图例选中后切换到该状态
|
||||
图例选中后切换到该状态
|
||||
|
||||
### size
|
||||
|
||||
**类型**：`'fit-content'` | `[number | string, number | string]`
|
||||
**类型**：`'fit-content' | [number | string, number | string]`
|
||||
|
||||
**默认值**：`'fit-content'`
|
||||
|
||||
|
||||
@ -9,19 +9,19 @@ LodController renders the text in the graph to a separate canvas, which has the
|
||||
- Keep the text size unchanged during canvas zooming
|
||||
- Provide the ability to control the text density to avoid visual confusion caused by too dense text
|
||||
|
||||
> ⚠️ LodController is a `singleton` plugin, G6 will register this plugin by default, no need to register manually.
|
||||
:::warning
|
||||
LodController is a `singleton` plugin, G6 will register this plugin by default, no need to register manually.
|
||||
:::
|
||||
|
||||
## Configuration
|
||||
|
||||
### debounce
|
||||
|
||||
**Type**: `'auto'` | `number`
|
||||
**Type**: `'auto' | number`
|
||||
|
||||
**Default**: `'auto'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Delay rendering time, in milliseconds
|
||||
Delay rendering time, in milliseconds
|
||||
|
||||
> When the main canvas is zoomed or panned, LodController will render the text again after a period of time to avoid frequent rendering
|
||||
|
||||
@ -31,9 +31,7 @@ LodController renders the text in the graph to a separate canvas, which has the
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to disable rendering text in different layers
|
||||
Whether to disable rendering text in different layers
|
||||
|
||||
### cellSize
|
||||
|
||||
@ -41,9 +39,7 @@ LodController renders the text in the graph to a separate canvas, which has the
|
||||
|
||||
**Default**: `200`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Cell size, in pixels
|
||||
Cell size, in pixels
|
||||
|
||||
### numberPerCell
|
||||
|
||||
@ -51,6 +47,4 @@ LodController renders the text in the graph to a separate canvas, which has the
|
||||
|
||||
**Default**: `1`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The maximum number of texts rendered in each cell
|
||||
The maximum number of texts rendered in each cell
|
||||
|
||||
@ -9,19 +9,19 @@ LodController 将图中的文本单独渲染到独立的 canvas 上，这样的
|
||||
- 在画布缩放过程中，能够保持文本字号不变
|
||||
- 提供了文本密度控制的能力，避免文本过于密集导致的视觉混乱
|
||||
|
||||
⚠️ LodController 是一个 `单例` 的插件，G6 会默认注册该插件，无需手动注册。
|
||||
:::warning{title=注意}
|
||||
LodController 是一个 `单例` 的插件，G6 会默认注册该插件，无需手动注册。
|
||||
:::
|
||||
|
||||
## 配置项
|
||||
|
||||
### debounce
|
||||
|
||||
**类型**：`'auto'` | `number`
|
||||
**类型**：`'auto' | number`
|
||||
|
||||
**默认值**：`'auto'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：延迟渲染时间，单位：毫秒
|
||||
延迟渲染时间，单位：毫秒
|
||||
|
||||
> 在主画布缩放、平移时，LodController 会延迟一段时间后再次渲染文本，以避免频繁渲染
|
||||
|
||||
@ -31,9 +31,7 @@ LodController 将图中的文本单独渲染到独立的 canvas 上，这样的
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否禁用信息分层渲染
|
||||
是否禁用信息分层渲染
|
||||
|
||||
### cellSize
|
||||
|
||||
@ -41,9 +39,7 @@ LodController 将图中的文本单独渲染到独立的 canvas 上，这样的
|
||||
|
||||
**默认值**：`200`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：单元格大小，单位：像素
|
||||
单元格大小，单位：像素
|
||||
|
||||
### numberPerCell
|
||||
|
||||
@ -51,6 +47,4 @@ LodController 将图中的文本单独渲染到独立的 canvas 上，这样的
|
||||
|
||||
**默认值**：`1`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：每个单元格中最多渲染的文本数量
|
||||
每个单元格中最多渲染的文本数量
|
||||
|
||||
@ -19,9 +19,7 @@ order: 5
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The callback function when the menu item is clicked
|
||||
The callback function when the menu item is clicked
|
||||
|
||||
### itemTypes
|
||||
|
||||
@ -29,9 +27,7 @@ order: 5
|
||||
|
||||
**Default**: `['node', 'edge', 'canvas']`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The object type to add menu items
|
||||
The object type to add menu items
|
||||
|
||||
### liHoverStyle
|
||||
|
||||
@ -58,9 +54,7 @@ order: 5
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The callback function when the menu is hidden
|
||||
The callback function when the menu is hidden
|
||||
|
||||
<embed src="../../common/PluginShouldBegin.en.md"></embed>
|
||||
|
||||
@ -70,14 +64,8 @@ order: 5
|
||||
|
||||
**Default**: `'click'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The trigger type of the menu
|
||||
|
||||
---
|
||||
The trigger type of the menu
|
||||
|
||||
## API
|
||||
|
||||
<embed src="../../common/PluginAPIDestroy.en.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
@ -19,9 +19,7 @@ order: 5
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：点击菜单项的回调函数
|
||||
点击菜单项的回调函数
|
||||
|
||||
### itemTypes
|
||||
|
||||
@ -29,9 +27,7 @@ order: 5
|
||||
|
||||
**默认值**：`['node', 'edge', 'canvas']`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：添加菜单项的对象类型
|
||||
添加菜单项的对象类型
|
||||
|
||||
### liHoverStyle
|
||||
|
||||
@ -46,9 +42,7 @@ order: 5
|
||||
};
|
||||
```
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：菜单项 hover 状态的样式
|
||||
菜单项 hover 状态的样式
|
||||
|
||||
<embed src="../../common/PluginLoadingContent.zh.md"></embed>
|
||||
|
||||
@ -58,9 +52,7 @@ order: 5
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：菜单隐藏时的回调函数
|
||||
菜单隐藏时的回调函数
|
||||
|
||||
<embed src="../../common/PluginShouldBegin.zh.md"></embed>
|
||||
|
||||
@ -70,14 +62,10 @@ order: 5
|
||||
|
||||
**默认值**：`'click'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：触发菜单的事件类型
|
||||
触发菜单的事件类型
|
||||
|
||||
---
|
||||
|
||||
## API
|
||||
|
||||
<embed src="../../common/PluginAPIDestroy.zh.md"></embed>
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
|
||||
@ -5,7 +5,7 @@ order: 6
|
||||
|
||||
When there is too much content on the canvas, you can use the MiniMap to view the overall content of the canvas, and you can use the MiniMap to move the canvas.
|
||||
|
||||
- [Minimap](/en/examples/tool/minimap/#minimap)]
|
||||
- [Minimap](/en/examples/tool/minimap/#minimap)
|
||||
- [Minimap API](/en/examples/tool/minimap/#minimap-api)
|
||||
|
||||
<img alt="minimap" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*XojSQY_-5iIAAAAAAAAAAAAADmJ7AQ/original" height='400'/>
|
||||
@ -16,7 +16,7 @@ When there is too much content on the canvas, you can use the MiniMap to view th
|
||||
|
||||
### delegateStyle
|
||||
|
||||
**Type**: `StyleConfig`
|
||||
**Type**: `ShapeStyle`
|
||||
|
||||
**Default**:
|
||||
|
||||
@ -37,19 +37,15 @@ When there is too much content on the canvas, you can use the MiniMap to view th
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to hide the edge in the MiniMap to improve performance
|
||||
Whether to hide the edge in the MiniMap to improve performance
|
||||
|
||||
### mode
|
||||
|
||||
**Type**: `'default'` | `'keyShape'` | `'delegate'`
|
||||
**Type**: `'default' | 'keyShape' | 'delegate'`
|
||||
|
||||
**Default**: `'default'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The mode of the MiniMap
|
||||
The mode of the MiniMap
|
||||
|
||||
- `'default'`: The default mode, the MiniMap will display all the content of the canvas
|
||||
- `'keyShape'`: Only the keyShape of all nodes in the canvas is displayed
|
||||
@ -61,9 +57,7 @@ When there is too much content on the canvas, you can use the MiniMap to view th
|
||||
|
||||
**Default**: `10`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The padding of the MiniMap
|
||||
The padding of the MiniMap
|
||||
|
||||
### refresh
|
||||
|
||||
@ -71,9 +65,7 @@ When there is too much content on the canvas, you can use the MiniMap to view th
|
||||
|
||||
**Default**: `true`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to refresh the MiniMap when the canvas is updated
|
||||
Whether to refresh the MiniMap when the canvas is updated
|
||||
|
||||
### size
|
||||
|
||||
@ -81,9 +73,7 @@ When there is too much content on the canvas, you can use the MiniMap to view th
|
||||
|
||||
**Default**: `[200, 120]`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The size of the MiniMap
|
||||
The size of the MiniMap
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ order: 6
|
||||
|
||||
当画布的内容过多时，可以通过缩略图来查看整体画布的内容，并且可以通过缩略图来移动画布
|
||||
|
||||
- [小地图导航](/examples/tool/minimap/#minimap)]
|
||||
- [小地图导航](/examples/tool/minimap/#minimap)
|
||||
- [通过 API 控制 Minimap](/examples/tool/minimap/#minimap-api)
|
||||
|
||||
<img alt="minimap" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*XojSQY_-5iIAAAAAAAAAAAAADmJ7AQ/original" height='400'/>
|
||||
@ -16,7 +16,7 @@ order: 6
|
||||
|
||||
### delegateStyle
|
||||
|
||||
**类型**：`StyleConfig`
|
||||
**类型**：`ShapeStyle`
|
||||
|
||||
**默认值**：
|
||||
|
||||
@ -27,9 +27,7 @@ order: 6
|
||||
}
|
||||
```
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：mode 为 `'delegate'` 时，缩略图中节点的样式
|
||||
mode 为 `'delegate'` 时，缩略图中节点的样式
|
||||
|
||||
### hideEdge
|
||||
|
||||
@ -37,19 +35,15 @@ order: 6
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否隐藏缩略图中的边以提高性能
|
||||
是否隐藏缩略图中的边以提高性能
|
||||
|
||||
### mode
|
||||
|
||||
**类型**：`'default'` | `'keyShape'` | `'delegate'`
|
||||
**类型**：`'default' | 'keyShape' | 'delegate'`
|
||||
|
||||
**默认值**：`'default'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：缩略图的模式
|
||||
缩略图的模式
|
||||
|
||||
- `'default'`：默认模式，缩略图会显示画布的所有内容
|
||||
- `'keyShape'`：只显示画布中所有节点的 keyShape
|
||||
@ -61,9 +55,7 @@ order: 6
|
||||
|
||||
**默认值**：`10`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：缩略图的内边距
|
||||
缩略图的内边距
|
||||
|
||||
### refresh
|
||||
|
||||
@ -71,9 +63,7 @@ order: 6
|
||||
|
||||
**默认值**：`true`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否在画布更新时刷新缩略图
|
||||
是否在画布更新时刷新缩略图
|
||||
|
||||
### size
|
||||
|
||||
@ -81,9 +71,7 @@ order: 6
|
||||
|
||||
**默认值**：`[200, 120]`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：缩略图的大小
|
||||
缩略图的大小
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@ -19,19 +19,15 @@ When two or more elements are aligned horizontally or vertically, alignment line
|
||||
|
||||
**Default**: `{}`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Snapline style
|
||||
Snapline style
|
||||
|
||||
### itemAlignType
|
||||
|
||||
**Type**: `boolean` | `'horizontal' | 'vertical'` | `'center'`
|
||||
**Type**: `boolean | 'horizontal' | 'vertical' | 'center'`
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Enable alignment line type
|
||||
Enable alignment line type
|
||||
|
||||
- `true`: Enable center, horizontal and vertical alignment lines
|
||||
- `false`: Do not enable alignment lines
|
||||
|
||||
@ -19,19 +19,15 @@ order: 13
|
||||
|
||||
**默认值**：`{}`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：对齐线样式
|
||||
对齐线样式
|
||||
|
||||
### itemAlignType
|
||||
|
||||
**类型**：`boolean` | `'horizontal' | 'vertical'` | `'center'`
|
||||
**类型**：`boolean | 'horizontal' | 'vertical' | 'center'`
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：启用对齐线类型
|
||||
启用对齐线类型
|
||||
|
||||
- `true`：启用中心、水平和垂直对齐线
|
||||
- `false`：不启用对齐线
|
||||
|
||||
@ -20,9 +20,7 @@ Filter graph elements through the time bar
|
||||
|
||||
**Default**: `{}`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Axis style
|
||||
Axis style
|
||||
|
||||
### chartStyle
|
||||
|
||||
@ -30,9 +28,7 @@ Filter graph elements through the time bar
|
||||
|
||||
**Default**: `{}`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Chart style
|
||||
Chart style
|
||||
|
||||
### controllerStyle
|
||||
|
||||
@ -40,9 +36,7 @@ Filter graph elements through the time bar
|
||||
|
||||
**Default**: `{}`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Controller style
|
||||
Controller style
|
||||
|
||||
### data
|
||||
|
||||
@ -50,9 +44,7 @@ Filter graph elements through the time bar
|
||||
|
||||
**Default**: `[]`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Time bar data
|
||||
Time bar data
|
||||
|
||||
### filter
|
||||
|
||||
@ -60,29 +52,23 @@ Filter graph elements through the time bar
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Take over the filtering logic, this callback will be called when the time bar value changes
|
||||
Take over the filtering logic, this callback will be called when the time bar value changes
|
||||
|
||||
### filterItemTypes
|
||||
|
||||
**Type**: `node` | `edge`
|
||||
**Type**: `node | edge`
|
||||
|
||||
**Default**: `node`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Filter element type
|
||||
Filter element type
|
||||
|
||||
### filterType
|
||||
|
||||
**Type**: `'modify'` | `'visibility'`
|
||||
**Type**: `'modify' | 'visibility'`
|
||||
|
||||
**Default**: `'modify'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Filter type
|
||||
Filter type
|
||||
|
||||
- `modify`: Filter by updating graph data
|
||||
- `visibility`: Filter by updating graph element visibility
|
||||
@ -93,9 +79,7 @@ Filter graph elements through the time bar
|
||||
|
||||
**Default**: Get `timestamp`, `time`, `date`, `datetime` field value in turn
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Get time value from graph element item
|
||||
Get time value from graph element item
|
||||
|
||||
### getTimeFromData
|
||||
|
||||
@ -103,9 +87,7 @@ Filter graph elements through the time bar
|
||||
|
||||
**Default**: Get `timestamp`, `time`, `date`, `datetime` field value in turn
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Get time value from time bar data
|
||||
Get time value from time bar data
|
||||
|
||||
### getValueFromData
|
||||
|
||||
@ -113,9 +95,7 @@ Filter graph elements through the time bar
|
||||
|
||||
**Default**: Get `value`, `date` field value in turn
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Get value from time bar data, used to draw in chart mode
|
||||
Get value from time bar data, used to draw in chart mode
|
||||
|
||||
### interval
|
||||
|
||||
@ -123,9 +103,7 @@ Filter graph elements through the time bar
|
||||
|
||||
**Default**: `'day'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Time interval in chart mode
|
||||
Time interval in chart mode
|
||||
|
||||
### labelFormatter
|
||||
|
||||
@ -133,9 +111,7 @@ Filter graph elements through the time bar
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Customize the time value format in chart mode
|
||||
Customize the time value format in chart mode
|
||||
|
||||
### loop
|
||||
|
||||
@ -143,9 +119,7 @@ Filter graph elements through the time bar
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to loop
|
||||
Whether to loop
|
||||
|
||||
### padding
|
||||
|
||||
@ -153,27 +127,28 @@ Filter graph elements through the time bar
|
||||
|
||||
**Default**: `10`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Padding
|
||||
Padding
|
||||
|
||||
### playMode
|
||||
|
||||
**Type**: `'acc'` | `'slide'`
|
||||
**Type**: `'acc' | 'slide'`
|
||||
|
||||
**Default**: `'acc'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Play mode
|
||||
Play mode
|
||||
|
||||
- `'acc'`: Accumulated play, that is, when playing to the n-th time point, the graph elements from the 1st to the n-th time point will be displayed
|
||||
- `'slide'`: Slide play, fixed display of the graph elements of the latest n time points
|
||||
|
||||
### shouldIgnore
|
||||
|
||||
**Type**:
|
||||
**Type**: `shouldIgnore`
|
||||
|
||||
<details>
|
||||
<summary style="color: #873bf4; cursor: pointer;">
|
||||
shouldIgnore
|
||||
</summary>
|
||||
|
||||
```ts
|
||||
type shouldIgnore = (
|
||||
model: Model,
|
||||
@ -181,6 +156,7 @@ type shouldIgnore = (
|
||||
dateRange: number | Date | [number, number] | [Date, Date],
|
||||
) => boolean;
|
||||
```
|
||||
</details>
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
@ -190,13 +166,11 @@ type shouldIgnore = (
|
||||
|
||||
### timebarType
|
||||
|
||||
**Type**: `'chart'` | `'time'`
|
||||
**Type**: `'chart' | 'time'`
|
||||
|
||||
**Default**: `'time'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Time bar type
|
||||
Time bar type
|
||||
|
||||
- `'chart`: Display as a bar chart
|
||||
|
||||
@ -212,9 +186,7 @@ type shouldIgnore = (
|
||||
|
||||
**Default**: The value of the first time point
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Time bar value or range
|
||||
Time bar value or range
|
||||
|
||||
### x
|
||||
|
||||
@ -222,9 +194,7 @@ type shouldIgnore = (
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: x coordinate
|
||||
x coordinate
|
||||
|
||||
### y
|
||||
|
||||
@ -232,21 +202,17 @@ type shouldIgnore = (
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: y coordinate
|
||||
y coordinate
|
||||
|
||||
<embed src="../../common/PluginSize.en.md"></embed>
|
||||
|
||||
### position
|
||||
|
||||
**Type**: `'top'` | `'bottom'` | `'left'` | `'right'`
|
||||
**Type**: `'top' | 'bottom' | 'left' | 'right'`
|
||||
|
||||
**Default**: `'bottom'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: position
|
||||
position
|
||||
|
||||
> Currently only supports `'bottom'`
|
||||
|
||||
@ -256,9 +222,7 @@ type shouldIgnore = (
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Backward callback
|
||||
Backward callback
|
||||
|
||||
### onChange
|
||||
|
||||
@ -266,9 +230,7 @@ type shouldIgnore = (
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Value change callback
|
||||
Value change callback
|
||||
|
||||
### onForward
|
||||
|
||||
@ -276,9 +238,7 @@ type shouldIgnore = (
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Forward callback
|
||||
Forward callback
|
||||
|
||||
### onPlay
|
||||
|
||||
@ -286,9 +246,7 @@ type shouldIgnore = (
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Play callback
|
||||
Play callback
|
||||
|
||||
### onPause
|
||||
|
||||
@ -296,9 +254,7 @@ type shouldIgnore = (
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Pause callback
|
||||
Pause callback
|
||||
|
||||
### onReset
|
||||
|
||||
@ -306,9 +262,7 @@ type shouldIgnore = (
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Reset callback
|
||||
Reset callback
|
||||
|
||||
### onSelectionTypeChange
|
||||
|
||||
@ -316,9 +270,7 @@ type shouldIgnore = (
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Selection type change callback
|
||||
Selection type change callback
|
||||
|
||||
### onChartTypeChange
|
||||
|
||||
@ -326,9 +278,7 @@ type shouldIgnore = (
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Chart type change callback
|
||||
Chart type change callback
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@ -20,9 +20,7 @@ order: 8
|
||||
|
||||
**默认值**：`{}`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：轴样式
|
||||
轴样式
|
||||
|
||||
### chartStyle
|
||||
|
||||
@ -30,9 +28,7 @@ order: 8
|
||||
|
||||
**默认值**：`{}`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图表样式
|
||||
图表样式
|
||||
|
||||
### controllerStyle
|
||||
|
||||
@ -40,9 +36,7 @@ order: 8
|
||||
|
||||
**默认值**：`{}`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：控制器样式
|
||||
控制器样式
|
||||
|
||||
### data
|
||||
|
||||
@ -50,9 +44,7 @@ order: 8
|
||||
|
||||
**默认值**：`[]`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：时间轴数据
|
||||
时间轴数据
|
||||
|
||||
### filter
|
||||
|
||||
@ -60,29 +52,23 @@ order: 8
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：接管过滤逻辑，当时间轴值变化时，会调用该回调
|
||||
接管过滤逻辑，当时间轴值变化时，会调用该回调
|
||||
|
||||
### filterItemTypes
|
||||
|
||||
**类型**：`node` | `edge`
|
||||
**类型**：`node | edge`
|
||||
|
||||
**默认值**：`node`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：过滤图元素类型
|
||||
过滤图元素类型
|
||||
|
||||
### filterType
|
||||
|
||||
**类型**：`'modify'` | `'visibility'`
|
||||
**类型**：`'modify' | 'visibility'`
|
||||
|
||||
**默认值**：`'modify'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：过滤类型
|
||||
过滤类型
|
||||
|
||||
- `modify`：通过更新图数据的方式进行过滤
|
||||
- `visibility`：通过更新图元素的可见性进行过滤
|
||||
@ -93,9 +79,7 @@ order: 8
|
||||
|
||||
**默认值**：依次尝试取 `timestamp`, `time`, `date`, `datetime` 字段属性值
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：从图元素数据中获取时间值
|
||||
从图元素数据中获取时间值
|
||||
|
||||
### getTimeFromData
|
||||
|
||||
@ -103,9 +87,7 @@ order: 8
|
||||
|
||||
**默认值**：依次尝试取 `timestamp`, `time`, `date`, `datetime` 字段属性值
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：从时间轴数据中获取时间值
|
||||
从时间轴数据中获取时间值
|
||||
|
||||
### getValueFromData
|
||||
|
||||
@ -113,9 +95,7 @@ order: 8
|
||||
|
||||
**默认值**：依次尝试取 `value`, `date` 字段属性值
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：从时间轴数据中获取值，用于在图表模式下进行绘制
|
||||
从时间轴数据中获取值，用于在图表模式下进行绘制
|
||||
|
||||
### interval
|
||||
|
||||
@ -123,9 +103,7 @@ order: 8
|
||||
|
||||
**默认值**：`'day'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图表模式下，需要指定时间间隔
|
||||
图表模式下，需要指定时间间隔
|
||||
|
||||
### labelFormatter
|
||||
|
||||
@ -133,9 +111,7 @@ order: 8
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图表模式下，时间值自定义格式化
|
||||
图表模式下，时间值自定义格式化
|
||||
|
||||
### loop
|
||||
|
||||
@ -143,9 +119,7 @@ order: 8
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否循环播放
|
||||
是否循环播放
|
||||
|
||||
### padding
|
||||
|
||||
@ -153,27 +127,28 @@ order: 8
|
||||
|
||||
**默认值**：`10`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：时间轴内边距
|
||||
时间轴内边距
|
||||
|
||||
### playMode
|
||||
|
||||
**类型**：`'acc'` | `'slide'`
|
||||
**类型**：`'acc' | 'slide'`
|
||||
|
||||
**默认值**：`'acc'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：播放模式
|
||||
播放模式
|
||||
|
||||
- `'acc'`：累加播放，即播放到第 n 个时间点时，会显示第 1 到第 n 个时间点的图元素
|
||||
- `'slide'`：滑动播放，固定显示最近 n 个时间点的图元素
|
||||
|
||||
### shouldIgnore
|
||||
|
||||
**类型**：
|
||||
**类型**：`shouldIgnore`
|
||||
|
||||
<details>
|
||||
<summary style="color: #873bf4; cursor: pointer;">
|
||||
shouldIgnore
|
||||
</summary>
|
||||
|
||||
```ts
|
||||
type shouldIgnore = (
|
||||
model: Model,
|
||||
@ -181,22 +156,19 @@ type shouldIgnore = (
|
||||
dateRange: number | Date | [number, number] | [Date, Date],
|
||||
) => boolean;
|
||||
```
|
||||
</details>
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：过滤图元素的回调，返回 `true` 表示忽略该图元素
|
||||
过滤图元素的回调，返回 `true` 表示忽略该图元素
|
||||
|
||||
### timebarType
|
||||
|
||||
**类型**：`'chart'` | `'time'`
|
||||
**类型**：`'chart' | 'time'`
|
||||
|
||||
**默认值**：`'time'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：时间轴类型
|
||||
时间轴类型
|
||||
|
||||
- `chart`：显示为条形图或柱状图
|
||||
|
||||
@ -212,9 +184,7 @@ type shouldIgnore = (
|
||||
|
||||
**默认值**：第一个时间点的值
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：时间点/时间范围
|
||||
时间点/时间范围
|
||||
|
||||
### x
|
||||
|
||||
@ -222,9 +192,7 @@ type shouldIgnore = (
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：x 坐标
|
||||
x 坐标
|
||||
|
||||
### y
|
||||
|
||||
@ -232,21 +200,17 @@ type shouldIgnore = (
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：y 坐标
|
||||
y 坐标
|
||||
|
||||
<embed src="../../common/PluginSize.zh.md"></embed>
|
||||
|
||||
### position
|
||||
|
||||
**类型**：`'top'` | `'bottom'` | `'left'` | `'right'`
|
||||
**类型**：`'top' | 'bottom' | 'left' | 'right'`
|
||||
|
||||
**默认值**：`'bottom'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：位置
|
||||
位置
|
||||
|
||||
> 目前仅支持 `'bottom'`
|
||||
|
||||
@ -256,9 +220,7 @@ type shouldIgnore = (
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：后退回调
|
||||
后退回调
|
||||
|
||||
### onChange
|
||||
|
||||
@ -266,9 +228,7 @@ type shouldIgnore = (
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：时间值变化回调
|
||||
时间值变化回调
|
||||
|
||||
### onForward
|
||||
|
||||
@ -276,9 +236,7 @@ type shouldIgnore = (
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：前进回调
|
||||
前进回调
|
||||
|
||||
### onPlay
|
||||
|
||||
@ -286,9 +244,7 @@ type shouldIgnore = (
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：播放回调
|
||||
播放回调
|
||||
|
||||
### onPause
|
||||
|
||||
@ -296,9 +252,7 @@ type shouldIgnore = (
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：暂停回调
|
||||
暂停回调
|
||||
|
||||
### onReset
|
||||
|
||||
@ -306,9 +260,7 @@ type shouldIgnore = (
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：重置回调
|
||||
重置回调
|
||||
|
||||
### onSelectionTypeChange
|
||||
|
||||
@ -316,9 +268,7 @@ type shouldIgnore = (
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：选择类型变化回调
|
||||
选择类型变化回调
|
||||
|
||||
### onChartTypeChange
|
||||
|
||||
@ -326,9 +276,7 @@ type shouldIgnore = (
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图表类型变化回调
|
||||
图表类型变化回调
|
||||
|
||||
## API
|
||||
|
||||
@ -336,31 +284,31 @@ type shouldIgnore = (
|
||||
|
||||
**类型**：`() => void;`
|
||||
|
||||
**说明**：后退
|
||||
后退
|
||||
|
||||
### forward
|
||||
|
||||
**类型**：`() => void;`
|
||||
|
||||
**说明**：前进
|
||||
前进
|
||||
|
||||
### pause
|
||||
|
||||
**类型**：`() => void;`
|
||||
|
||||
**说明**：暂停
|
||||
暂停
|
||||
|
||||
### play
|
||||
|
||||
**类型**：`() => void;`
|
||||
|
||||
**说明**：播放
|
||||
播放
|
||||
|
||||
### reset
|
||||
|
||||
**类型**：`() => void;`
|
||||
|
||||
**说明**：重置
|
||||
重置
|
||||
|
||||
<embed src="../../common/PluginAPIDestroy.zh.md"></embed>
|
||||
|
||||
|
||||
@ -16,18 +16,14 @@ order: 7
|
||||
|
||||
**Type**: `(code: string, evt: IG6GraphEvent) => void`
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Click event callback
|
||||
Click event callback
|
||||
|
||||
<embed src="../../common/PluginGetContent.en.md"></embed>
|
||||
|
||||
## API
|
||||
|
||||
<embed src="../../common/PluginAPIDestroy.en.md"></embed>
|
||||
|
||||
---
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.en.md"></embed>
|
||||
|
||||
@ -16,11 +16,11 @@ order: 7
|
||||
|
||||
**类型**：`(code: string, evt: IG6GraphEvent) => void`
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：点击事件回调
|
||||
点击事件回调
|
||||
|
||||
<embed src="../../common/PluginGetContent.zh.md"></embed>
|
||||
|
||||
@ -32,9 +32,7 @@ order: 7
|
||||
|
||||
**默认值**：`0.00001`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：最小缩放比例
|
||||
最小缩放比例
|
||||
|
||||
### maxZoom
|
||||
|
||||
@ -42,9 +40,7 @@ order: 7
|
||||
|
||||
**默认值**：`1000`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：最大缩放比例
|
||||
最大缩放比例
|
||||
|
||||
### zoomSensitivity
|
||||
|
||||
@ -52,9 +48,7 @@ order: 7
|
||||
|
||||
**默认值**：`10`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：缩放灵敏度 -->
|
||||
缩放灵敏度 -->
|
||||
|
||||
## API
|
||||
|
||||
@ -63,7 +57,3 @@ order: 7
|
||||
<!-- TODO 待实现添加 add/update/remove API -->
|
||||
|
||||
<embed src="../../common/PluginAPIDestroy.zh.md"></embed>
|
||||
|
||||
---
|
||||
|
||||
<embed src="../../common/IG6GraphEvent.zh.md"></embed>
|
||||
|
||||
@ -14,13 +14,11 @@ order: 4
|
||||
|
||||
### fixToNode
|
||||
|
||||
**Type**: `[number, number]` | `Placement` | `undefined`
|
||||
**Type**: `[number, number] | Placement | undefined`
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Fix the position to the node
|
||||
Fix the position to the node
|
||||
|
||||
<embed src="../../common/PluginGetContent.en.md"></embed>
|
||||
|
||||
@ -30,9 +28,7 @@ order: 4
|
||||
|
||||
**Default**: `['node', 'edge', 'combo']`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The types of the items to add the tooltip
|
||||
The types of the items to add the tooltip
|
||||
|
||||
<embed src="../../common/PluginLoadingContent.en.md"></embed>
|
||||
|
||||
@ -42,9 +38,7 @@ order: 4
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: x offset
|
||||
x offset
|
||||
|
||||
### offsetY
|
||||
|
||||
@ -52,21 +46,17 @@ order: 4
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: y offset
|
||||
y offset
|
||||
|
||||
<embed src="../../common/PluginShouldBegin.en.md"></embed>
|
||||
|
||||
### trigger
|
||||
|
||||
**Type**: `'pointerenter'` | `'click'`
|
||||
**Type**: `'pointerenter' | 'click'`
|
||||
|
||||
**Default**: `'pointerenter'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The trigger event type
|
||||
The trigger event type
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@ -14,13 +14,11 @@ order: 4
|
||||
|
||||
### fixToNode
|
||||
|
||||
**类型**：`[number, number]` | `Placement` | `undefined`
|
||||
**类型**：`[number, number] | Placement | undefined`
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：固定到节点的位置
|
||||
固定到节点的位置
|
||||
|
||||
<embed src="../../common/PluginGetContent.zh.md"></embed>
|
||||
|
||||
@ -30,9 +28,7 @@ order: 4
|
||||
|
||||
**默认值**：`['node', 'edge', 'combo']`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：添加菜单项的对象类型
|
||||
添加菜单项的对象类型
|
||||
|
||||
<embed src="../../common/PluginLoadingContent.zh.md"></embed>
|
||||
|
||||
@ -42,9 +38,7 @@ order: 4
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：x 轴偏移量
|
||||
x 轴偏移量
|
||||
|
||||
### offsetY
|
||||
|
||||
@ -52,21 +46,17 @@ order: 4
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：y 轴偏移量
|
||||
y 轴偏移量
|
||||
|
||||
<embed src="../../common/PluginShouldBegin.zh.md"></embed>
|
||||
|
||||
### trigger
|
||||
|
||||
**类型**：`'pointerenter'` | `'click'`
|
||||
**类型**：`'pointerenter' | 'click'`
|
||||
|
||||
**默认值**：`'pointerenter'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：触发交互的事件类型
|
||||
触发交互的事件类型
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@ -18,9 +18,7 @@ order: 9
|
||||
|
||||
**Default**: `[0, 0]`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Watermark start position
|
||||
Watermark start position
|
||||
|
||||
### image
|
||||
|
||||
@ -28,9 +26,7 @@ order: 9
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Image watermark configuration
|
||||
Image watermark configuration
|
||||
|
||||
### mode
|
||||
|
||||
@ -38,9 +34,7 @@ order: 9
|
||||
|
||||
**Default**: `'image'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Watermark type
|
||||
Watermark type
|
||||
|
||||
### position
|
||||
|
||||
@ -48,9 +42,7 @@ order: 9
|
||||
|
||||
**Default**: `'middle'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Watermark position
|
||||
Watermark position
|
||||
|
||||
- `top`: Top layer canvas (above the graph)
|
||||
- `middle`: Middle layer canvas
|
||||
@ -62,9 +54,7 @@ order: 9
|
||||
|
||||
**Default**: `[100, 100]`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The distance between the watermark and the canvas
|
||||
The distance between the watermark and the canvas
|
||||
|
||||
<embed src="../../common/PluginSize.en.md"></embed>
|
||||
|
||||
@ -74,9 +64,7 @@ order: 9
|
||||
|
||||
**Default**: `undefined`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Text watermark configuration
|
||||
Text watermark configuration
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@ -18,9 +18,7 @@ order: 9
|
||||
|
||||
**默认值**：`[0, 0]`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：水印开始位置
|
||||
水印开始位置
|
||||
|
||||
### image
|
||||
|
||||
@ -28,9 +26,7 @@ order: 9
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图片水印配置项
|
||||
图片水印配置项
|
||||
|
||||
### mode
|
||||
|
||||
@ -38,9 +34,7 @@ order: 9
|
||||
|
||||
**默认值**：`'image'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：水印类型
|
||||
水印类型
|
||||
|
||||
### position
|
||||
|
||||
@ -48,9 +42,7 @@ order: 9
|
||||
|
||||
**默认值**：`'middle'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：水印位置
|
||||
水印位置
|
||||
|
||||
- `top`：顶层画布（位于图上层）
|
||||
- `middle`：中间层画布
|
||||
@ -64,9 +56,7 @@ order: 9
|
||||
|
||||
**默认值**：`[100, 100]`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：水印间隔
|
||||
水印间隔
|
||||
|
||||
<embed src="../../common/PluginSize.zh.md"></embed>
|
||||
|
||||
@ -76,9 +66,7 @@ order: 9
|
||||
|
||||
**默认值**：`undefined`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：文字水印配置项
|
||||
文字水印配置项
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@ -9,9 +9,7 @@ order: 0
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The x coordinate of the center of the circle
|
||||
The x coordinate of the center of the circle
|
||||
|
||||
## cy
|
||||
|
||||
@ -19,9 +17,7 @@ order: 0
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The y coordinate of the center of the circle
|
||||
The y coordinate of the center of the circle
|
||||
|
||||
## r
|
||||
|
||||
@ -29,8 +25,6 @@ order: 0
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The radius of the circle
|
||||
The radius of the circle
|
||||
|
||||
<embed src="../../common/BaseStyleProps.en.md"></embed>
|
||||
|
||||
@ -9,9 +9,7 @@ order: 0
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：圆心的 x 坐标
|
||||
圆心的 x 坐标
|
||||
|
||||
## cy
|
||||
|
||||
@ -19,9 +17,7 @@ order: 0
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：圆心的 y 坐标
|
||||
圆心的 y 坐标
|
||||
|
||||
## r
|
||||
|
||||
@ -29,8 +25,6 @@ order: 0
|
||||
|
||||
**默认值**： `0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：圆形的半径
|
||||
圆形的半径
|
||||
|
||||
<embed src="../../common/BaseStyleProps.zh.md"></embed>
|
||||
|
||||
@ -15,9 +15,7 @@ Cube Geometry
|
||||
|
||||
**Default**: `1`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: depth
|
||||
depth
|
||||
|
||||
## widthSegments
|
||||
|
||||
@ -25,9 +23,7 @@ Cube Geometry
|
||||
|
||||
**Default**: `1`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: width segments
|
||||
width segments
|
||||
|
||||
## heightSegments
|
||||
|
||||
@ -35,9 +31,7 @@ Cube Geometry
|
||||
|
||||
**Default**: `1`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: height segments
|
||||
height segments
|
||||
|
||||
## depthSegments
|
||||
|
||||
@ -45,6 +39,4 @@ Cube Geometry
|
||||
|
||||
**Default**: `1`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: depth segments
|
||||
depth segments
|
||||
|
||||
@ -13,9 +13,7 @@ order: 10
|
||||
|
||||
**默认值**：`1`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：深度
|
||||
深度
|
||||
|
||||
## widthSegments
|
||||
|
||||
@ -23,9 +21,7 @@ order: 10
|
||||
|
||||
**默认值**：`1`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：宽度分段数
|
||||
宽度分段数
|
||||
|
||||
## heightSegments
|
||||
|
||||
@ -33,9 +29,7 @@ order: 10
|
||||
|
||||
**默认值**：`1`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：高度分段数
|
||||
高度分段数
|
||||
|
||||
## depthSegments
|
||||
|
||||
@ -43,6 +37,4 @@ order: 10
|
||||
|
||||
**默认值**：`1`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：深度分段数
|
||||
深度分段数
|
||||
|
||||
@ -9,9 +9,7 @@ order: 7
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The x coordinate of the center of the ellipse
|
||||
The x coordinate of the center of the ellipse
|
||||
|
||||
## cy
|
||||
|
||||
@ -19,9 +17,7 @@ order: 7
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The y coordinate of the center of the ellipse
|
||||
The y coordinate of the center of the ellipse
|
||||
|
||||
## rx
|
||||
|
||||
@ -29,9 +25,7 @@ order: 7
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The horizontal radius of the ellipse
|
||||
The horizontal radius of the ellipse
|
||||
|
||||
## ry
|
||||
|
||||
@ -39,8 +33,6 @@ order: 7
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The vertical radius of the ellipse
|
||||
The vertical radius of the ellipse
|
||||
|
||||
<embed src="../../common/BaseStyleProps.en.md"></embed>
|
||||
|
||||
@ -9,9 +9,7 @@ order: 7
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：椭圆心的 x 坐标
|
||||
椭圆心的 x 坐标
|
||||
|
||||
## cy
|
||||
|
||||
@ -19,9 +17,7 @@ order: 7
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：椭圆心的 y 坐标
|
||||
椭圆心的 y 坐标
|
||||
|
||||
## rx
|
||||
|
||||
@ -29,9 +25,7 @@ order: 7
|
||||
|
||||
**默认值**： `0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：椭圆的水平半径
|
||||
椭圆的水平半径
|
||||
|
||||
## ry
|
||||
|
||||
@ -39,8 +33,6 @@ order: 7
|
||||
|
||||
**默认值**： `0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：椭圆的垂直半径
|
||||
椭圆的垂直半径
|
||||
|
||||
<embed src="../../common/BaseStyleProps.zh.md"></embed>
|
||||
|
||||
@ -7,13 +7,11 @@ order: 3
|
||||
|
||||
## img
|
||||
|
||||
**Type**: `string` | `HTMLImageElement`
|
||||
**Type**: `string | HTMLImageElement`
|
||||
|
||||
**Default**: `null`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: image object
|
||||
image object
|
||||
|
||||
## src
|
||||
|
||||
@ -21,8 +19,6 @@ order: 3
|
||||
|
||||
**Default**: `null`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: image url
|
||||
image url
|
||||
|
||||
<embed src="../../common/BaseStyleProps.en.md"></embed>
|
||||
|
||||
@ -7,13 +7,11 @@ order: 3
|
||||
|
||||
## img
|
||||
|
||||
**类型**：`string` | `HTMLImageElement`
|
||||
**类型**：`string | HTMLImageElement`
|
||||
|
||||
**默认值**：`null`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图片对象
|
||||
图片对象
|
||||
|
||||
## src
|
||||
|
||||
@ -21,8 +19,6 @@ order: 3
|
||||
|
||||
**默认值**：`null`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图片地址
|
||||
图片地址
|
||||
|
||||
<embed src="../../common/BaseStyleProps.zh.md"></embed>
|
||||
|
||||
@ -9,9 +9,7 @@ order: 4
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The x coordinate of the start point
|
||||
The x coordinate of the start point
|
||||
|
||||
## y1
|
||||
|
||||
@ -19,9 +17,7 @@ order: 4
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The y coordinate of the start point
|
||||
The y coordinate of the start point
|
||||
|
||||
## x2
|
||||
|
||||
@ -29,9 +25,7 @@ order: 4
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The x coordinate of the end point
|
||||
The x coordinate of the end point
|
||||
|
||||
## y2
|
||||
|
||||
@ -39,9 +33,7 @@ order: 4
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The y coordinate of the end point
|
||||
The y coordinate of the end point
|
||||
|
||||
## markerStart
|
||||
|
||||
@ -49,9 +41,7 @@ order: 4
|
||||
|
||||
**Default**: `null`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Marker at the start point
|
||||
Marker at the start point
|
||||
|
||||
## markerEnd
|
||||
|
||||
@ -59,9 +49,7 @@ order: 4
|
||||
|
||||
**Default**: `null`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Marker at the end point
|
||||
Marker at the end point
|
||||
|
||||
## markerStartOffset
|
||||
|
||||
@ -69,9 +57,7 @@ order: 4
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The offset of the start marker
|
||||
The offset of the start marker
|
||||
|
||||
## markerEndOffset
|
||||
|
||||
@ -79,8 +65,6 @@ order: 4
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The offset of the end marker
|
||||
The offset of the end marker
|
||||
|
||||
<embed src="../../common/BaseStyleProps.en.md"></embed>
|
||||
|
||||
@ -9,9 +9,7 @@ order: 4
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：起点的 x 坐标
|
||||
起点的 x 坐标
|
||||
|
||||
## y1
|
||||
|
||||
@ -19,9 +17,7 @@ order: 4
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：起点的 y 坐标
|
||||
起点的 y 坐标
|
||||
|
||||
## x2
|
||||
|
||||
@ -29,9 +25,7 @@ order: 4
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：终点的 x 坐标
|
||||
终点的 x 坐标
|
||||
|
||||
## y2
|
||||
|
||||
@ -39,9 +33,7 @@ order: 4
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：终点的 y 坐标
|
||||
终点的 y 坐标
|
||||
|
||||
## markerStart
|
||||
|
||||
@ -49,9 +41,7 @@ order: 4
|
||||
|
||||
**默认值**：`null`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：起点标记图形
|
||||
起点标记图形
|
||||
|
||||
## markerEnd
|
||||
|
||||
@ -59,9 +49,7 @@ order: 4
|
||||
|
||||
**默认值**：`null`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：终点标记图形
|
||||
终点标记图形
|
||||
|
||||
## markerStartOffset
|
||||
|
||||
@ -69,9 +57,7 @@ order: 4
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：起点标记图形在直线上的偏移量
|
||||
起点标记图形在直线上的偏移量
|
||||
|
||||
## markerEndOffset
|
||||
|
||||
@ -79,8 +65,6 @@ order: 4
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：终点标记图形在直线上的偏移量
|
||||
终点标记图形在直线上的偏移量
|
||||
|
||||
<embed src="../../common/BaseStyleProps.zh.md"></embed>
|
||||
|
||||
@ -5,13 +5,11 @@ order: 5
|
||||
|
||||
## path
|
||||
|
||||
**Type**: `string` | `PathCommand[]`
|
||||
**Type**: `string | PathCommand[]`
|
||||
|
||||
**Default**: `''`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Path string or path command array
|
||||
Path string or path command array
|
||||
|
||||
<embed src="../../common/Marker.en.md"></embed>
|
||||
|
||||
|
||||
@ -5,13 +5,11 @@ order: 5
|
||||
|
||||
## path
|
||||
|
||||
**类型**：`string` | `PathCommand[]`
|
||||
**类型**：`string | PathCommand[]`
|
||||
|
||||
**默认值**：`''`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：路径字符串或者路径命令数组
|
||||
路径字符串或者路径命令数组
|
||||
|
||||
<embed src="../../common/Marker.zh.md"></embed>
|
||||
|
||||
|
||||
@ -13,9 +13,7 @@ Plane geometry, default lying on the XZ plane
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: width
|
||||
width
|
||||
|
||||
## depth
|
||||
|
||||
@ -23,9 +21,7 @@ Plane geometry, default lying on the XZ plane
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: depth
|
||||
depth
|
||||
|
||||
## widthSegments
|
||||
|
||||
@ -33,9 +29,7 @@ Plane geometry, default lying on the XZ plane
|
||||
|
||||
**Default**: `1`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: width segments
|
||||
width segments
|
||||
|
||||
## depthSegments
|
||||
|
||||
@ -43,6 +37,4 @@ Plane geometry, default lying on the XZ plane
|
||||
|
||||
**Default**: `1`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: depth segments
|
||||
depth segments
|
||||
|
||||
@ -13,9 +13,7 @@ order: 11
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：宽度
|
||||
宽度
|
||||
|
||||
## depth
|
||||
|
||||
@ -23,9 +21,7 @@ order: 11
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：深度
|
||||
深度
|
||||
|
||||
## widthSegments
|
||||
|
||||
@ -33,9 +29,7 @@ order: 11
|
||||
|
||||
**默认值**：`1`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：宽度分段数
|
||||
宽度分段数
|
||||
|
||||
## depthSegments
|
||||
|
||||
@ -43,6 +37,4 @@ order: 11
|
||||
|
||||
**默认值**：`1`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：深度分段数
|
||||
深度分段数
|
||||
|
||||
@ -9,9 +9,7 @@ order: 8
|
||||
|
||||
**Default**: `[]`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The vertex coordinate array of the polygon
|
||||
The vertex coordinate array of the polygon
|
||||
|
||||
## isClosed
|
||||
|
||||
@ -19,9 +17,7 @@ order: 8
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether it is closed
|
||||
Whether it is closed
|
||||
|
||||
<embed src="../../common/Marker.en.md"></embed>
|
||||
|
||||
|
||||
@ -9,9 +9,7 @@ order: 8
|
||||
|
||||
**默认值**：`[]`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：多边形的顶点坐标数组
|
||||
多边形的顶点坐标数组
|
||||
|
||||
## isClosed
|
||||
|
||||
@ -19,9 +17,7 @@ order: 8
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否闭合
|
||||
是否闭合
|
||||
|
||||
<embed src="../../common/Marker.zh.md"></embed>
|
||||
|
||||
|
||||
@ -7,12 +7,10 @@ order: 1
|
||||
|
||||
## radius
|
||||
|
||||
**Type**: `number` | `number[]`
|
||||
**Type**: `number | number[]`
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Radius of rounded corners
|
||||
Radius of rounded corners
|
||||
|
||||
<embed src="../../common/BaseStyleProps.en.md"></embed>
|
||||
|
||||
@ -7,12 +7,10 @@ order: 1
|
||||
|
||||
## radius
|
||||
|
||||
**类型**：`number` | `number[]`
|
||||
**类型**：`number | number[]`
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：圆角半径
|
||||
圆角半径
|
||||
|
||||
<embed src="../../common/BaseStyleProps.zh.md"></embed>
|
||||
|
||||
@ -13,9 +13,7 @@ Sphere Geometry
|
||||
|
||||
**Default**: `0.5`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: radius
|
||||
radius
|
||||
|
||||
## latitudeBands
|
||||
|
||||
@ -23,9 +21,7 @@ Sphere Geometry
|
||||
|
||||
**Default**: `16`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: latitude bands
|
||||
latitude bands
|
||||
|
||||
## longitudeBands
|
||||
|
||||
@ -33,6 +29,4 @@ Sphere Geometry
|
||||
|
||||
**Default**: `16`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: longitude bands
|
||||
longitude bands
|
||||
|
||||
@ -11,9 +11,7 @@ order: 9
|
||||
|
||||
**默认值**：`0.5`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：radius
|
||||
radius
|
||||
|
||||
## latitudeBands
|
||||
|
||||
@ -21,9 +19,7 @@ order: 9
|
||||
|
||||
**默认值**：`16`
|
||||
|
||||
**是否必须**：ffalse
|
||||
|
||||
**说明**：latitude bands
|
||||
latitude bands
|
||||
|
||||
## longitudeBands
|
||||
|
||||
@ -31,6 +27,4 @@ order: 9
|
||||
|
||||
**默认值**：`16`
|
||||
|
||||
**是否必须**：ffalse
|
||||
|
||||
**说明**：longitude bands
|
||||
longitude bands
|
||||
|
||||
@ -9,9 +9,7 @@ order: 2
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The x-axis offset
|
||||
The x-axis offset
|
||||
|
||||
## dy
|
||||
|
||||
@ -19,9 +17,7 @@ order: 2
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The y-axis offset
|
||||
The y-axis offset
|
||||
|
||||
## fontFamily
|
||||
|
||||
@ -29,9 +25,7 @@ order: 2
|
||||
|
||||
**Default**: `''`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: font family
|
||||
font family
|
||||
|
||||
## fontSize
|
||||
|
||||
@ -39,39 +33,31 @@ order: 2
|
||||
|
||||
**Default**: `10`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: font size
|
||||
font size
|
||||
|
||||
## fontStyle
|
||||
|
||||
**Type**: `'normal'` | `'italic'` | `'oblique'`
|
||||
**Type**: `'normal' | 'italic' | 'oblique'`
|
||||
|
||||
**Default**: `'normal'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: font style
|
||||
font style
|
||||
|
||||
## fontVariant
|
||||
|
||||
**Type**: `'normal'` | `'small-caps'`
|
||||
**Type**: `'normal' | 'small-caps'`
|
||||
|
||||
**Default**: `'normal'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: font variant
|
||||
font variant
|
||||
|
||||
## fontWeight
|
||||
|
||||
**Type**: `'normal'` | `'bold'` | `'bolder'` | `'lighter'` | `number`
|
||||
**Type**: `'normal' | 'bold' | 'bolder' | 'lighter' | number`
|
||||
|
||||
**Default**: `'normal'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: font weight
|
||||
font weight
|
||||
|
||||
## leading
|
||||
|
||||
@ -79,9 +65,7 @@ order: 2
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: leading
|
||||
leading
|
||||
|
||||
## letterSpacing
|
||||
|
||||
@ -89,9 +73,7 @@ order: 2
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: letter spacing
|
||||
letter spacing
|
||||
|
||||
## lineHeight
|
||||
|
||||
@ -99,9 +81,7 @@ order: 2
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: line height
|
||||
line height
|
||||
|
||||
## text
|
||||
|
||||
@ -109,29 +89,23 @@ order: 2
|
||||
|
||||
**Default**: `''`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: text content
|
||||
text content
|
||||
|
||||
## textAlign
|
||||
|
||||
**Type**: `'start'` | `'center'` | `'middle'` | `'end'` | `'left'` | `'right'`
|
||||
**Type**: `'start' | 'center' | 'middle' | 'end' | 'left' | 'right'`
|
||||
|
||||
**Default**: `'start'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: text align
|
||||
text align
|
||||
|
||||
## textBaseline
|
||||
|
||||
**Type**: `'top'` | `'hanging'` | `'middle'` | `'alphabetic'` | `'ideographic'` | `'bottom'`
|
||||
**Type**: `'top' | 'hanging' | 'middle' | 'alphabetic' | 'ideographic' | 'bottom'`
|
||||
|
||||
**Default**: `'alphabetic'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: text baseline
|
||||
text baseline
|
||||
|
||||
## textDecorationColor
|
||||
|
||||
@ -139,39 +113,31 @@ order: 2
|
||||
|
||||
**Default**: `''`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: text decoration color
|
||||
text decoration color
|
||||
|
||||
## textDecorationLine
|
||||
|
||||
**Type**: `'none'` | `'underline'` | `'overline'` | `'line-through'` | `'blink'`
|
||||
**Type**: `'none' | 'underline' | 'overline' | 'line-through' | 'blink'`
|
||||
|
||||
**Default**: `'none'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: text decoration line
|
||||
text decoration line
|
||||
|
||||
## textDecorationStyle
|
||||
|
||||
**Type**: `'solid'` | `'double'` | `'dotted'` | `'dashed'` | `'wavy'`
|
||||
**Type**: `'solid' | 'double' | 'dotted' | 'dashed' | 'wavy'`
|
||||
|
||||
**Default**: `'solid'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: text decoration style
|
||||
text decoration style
|
||||
|
||||
## textOverflow
|
||||
|
||||
**Type**: `'ellipsis'` | `'clip'` | `string`
|
||||
**Type**: `'ellipsis' | 'clip' | string`
|
||||
|
||||
**Default**: `'clip'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: text overflow
|
||||
text overflow
|
||||
|
||||
## textPath
|
||||
|
||||
@ -179,19 +145,15 @@ order: 2
|
||||
|
||||
**Default**: `''`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: text path
|
||||
text path
|
||||
|
||||
## textPathSide
|
||||
|
||||
**Type**: `'left'` | `'right'`
|
||||
**Type**: `'left' | 'right'`
|
||||
|
||||
**Default**: `'left'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: text path side
|
||||
text path side
|
||||
|
||||
## textPathStartOffset
|
||||
|
||||
@ -199,9 +161,7 @@ order: 2
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: text path start offset
|
||||
text path start offset
|
||||
|
||||
## wordWrap
|
||||
|
||||
@ -209,9 +169,7 @@ order: 2
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: word wrap
|
||||
word wrap
|
||||
|
||||
## wordWrapWidth
|
||||
|
||||
@ -219,8 +177,6 @@ order: 2
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: word wrap width
|
||||
word wrap width
|
||||
|
||||
<embed src="../../common/Position.en.md"></embed>
|
||||
|
||||
@ -9,9 +9,7 @@ order: 2
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：x 方向偏移量
|
||||
x 方向偏移量
|
||||
|
||||
## dy
|
||||
|
||||
@ -19,9 +17,7 @@ order: 2
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：y 方向偏移量
|
||||
y 方向偏移量
|
||||
|
||||
## fontFamily
|
||||
|
||||
@ -29,9 +25,7 @@ order: 2
|
||||
|
||||
**默认值**：`''`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：字体
|
||||
字体
|
||||
|
||||
## fontSize
|
||||
|
||||
@ -39,39 +33,31 @@ order: 2
|
||||
|
||||
**默认值**：`10`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：字体大小
|
||||
字体大小
|
||||
|
||||
## fontStyle
|
||||
|
||||
**类型**：`'normal'` | `'italic'` | `'oblique'`
|
||||
**类型**：`'normal' | 'italic' | 'oblique'`
|
||||
|
||||
**默认值**：`'normal'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：字体样式
|
||||
字体样式
|
||||
|
||||
## fontVariant
|
||||
|
||||
**类型**：`'normal'` | `'small-caps'`
|
||||
**类型**：`'normal' | 'small-caps'`
|
||||
|
||||
**默认值**：`'normal'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：字体变体
|
||||
字体变体
|
||||
|
||||
## fontWeight
|
||||
|
||||
**类型**：`'normal'` | `'bold'` | `'bolder'` | `'lighter'` | `number`
|
||||
**类型**：`'normal' | 'bold' | 'bolder' | 'lighter' | number`
|
||||
|
||||
**默认值**：`'normal'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：字体粗细
|
||||
字体粗细
|
||||
|
||||
## leading
|
||||
|
||||
@ -79,9 +65,7 @@ order: 2
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：行距
|
||||
行距
|
||||
|
||||
## letterSpacing
|
||||
|
||||
@ -89,9 +73,7 @@ order: 2
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：字间距
|
||||
字间距
|
||||
|
||||
## lineHeight
|
||||
|
||||
@ -99,9 +81,7 @@ order: 2
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：行高
|
||||
行高
|
||||
|
||||
## text
|
||||
|
||||
@ -109,29 +89,23 @@ order: 2
|
||||
|
||||
**默认值**：`''`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：文本内容
|
||||
文本内容
|
||||
|
||||
## textAlign
|
||||
|
||||
**类型**：`'start'` | `'center'` | `'middle'` | `'end'` | `'left'` | `'right'`
|
||||
**类型**：`'start' | 'center' | 'middle' | 'end' | 'left' | 'right'`
|
||||
|
||||
**默认值**：`'start'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：文本对齐方式
|
||||
文本对齐方式
|
||||
|
||||
## textBaseline
|
||||
|
||||
**类型**：`'top'` | `'hanging'` | `'middle'` | `'alphabetic'` | `'ideographic'` | `'bottom'`
|
||||
**类型**：`'top' | 'hanging' | 'middle' | 'alphabetic' | 'ideographic' | 'bottom'`
|
||||
|
||||
**默认值**：`'alphabetic'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：文本基线对齐方式
|
||||
文本基线对齐方式
|
||||
|
||||
## textDecorationColor
|
||||
|
||||
@ -139,39 +113,31 @@ order: 2
|
||||
|
||||
**默认值**：`''`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：文本修饰线颜色
|
||||
文本修饰线颜色
|
||||
|
||||
## textDecorationLine
|
||||
|
||||
**类型**：`'none'` | `'underline'` | `'overline'` | `'line-through'` | `'blink'`
|
||||
**类型**：`'none' | 'underline' | 'overline' | 'line-through' | 'blink'`
|
||||
|
||||
**默认值**：`'none'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：文本修饰线
|
||||
文本修饰线
|
||||
|
||||
## textDecorationStyle
|
||||
|
||||
**类型**：`'solid'` | `'double'` | `'dotted'` | `'dashed'` | `'wavy'`
|
||||
**类型**：`'solid' | 'double' | 'dotted' | 'dashed' | 'wavy'`
|
||||
|
||||
**默认值**：`'solid'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：文本修饰线样式
|
||||
文本修饰线样式
|
||||
|
||||
## textOverflow
|
||||
|
||||
**类型**：`'ellipsis'` | `'clip'` | `string`
|
||||
**类型**：`'ellipsis' | 'clip' | string`
|
||||
|
||||
**默认值**：`'clip'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：文本溢出处理方式
|
||||
文本溢出处理方式
|
||||
|
||||
## textPath
|
||||
|
||||
@ -179,19 +145,15 @@ order: 2
|
||||
|
||||
**默认值**：`''`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：文本路径
|
||||
文本路径
|
||||
|
||||
## textPathSide
|
||||
|
||||
**类型**：`'left'` | `'right'`
|
||||
**类型**：`'left' | 'right'`
|
||||
|
||||
**默认值**：`'left'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：文本路径方向
|
||||
文本路径方向
|
||||
|
||||
## textPathStartOffset
|
||||
|
||||
@ -199,9 +161,7 @@ order: 2
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：文本路径起始偏移量
|
||||
文本路径起始偏移量
|
||||
|
||||
## wordWrap
|
||||
|
||||
@ -209,9 +169,7 @@ order: 2
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否自动换行
|
||||
是否自动换行
|
||||
|
||||
## wordWrapWidth
|
||||
|
||||
@ -219,8 +177,6 @@ order: 2
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：自动换行宽度
|
||||
自动换行宽度
|
||||
|
||||
<embed src="../../common/Position.zh.md"></embed>
|
||||
|
||||
@ -13,9 +13,7 @@ Torus Geometry
|
||||
|
||||
**Default**: `0.2`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The radius of the tube
|
||||
The radius of the tube
|
||||
|
||||
## ringRadius
|
||||
|
||||
@ -23,9 +21,7 @@ Torus Geometry
|
||||
|
||||
**Default**: `0.3`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The radius of the ring
|
||||
The radius of the ring
|
||||
|
||||
## segments
|
||||
|
||||
@ -33,9 +29,7 @@ Torus Geometry
|
||||
|
||||
**Default**: `30`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The number of segments
|
||||
The number of segments
|
||||
|
||||
## sides
|
||||
|
||||
@ -43,6 +37,4 @@ Torus Geometry
|
||||
|
||||
**Default**: `20`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The number of sides
|
||||
The number of sides
|
||||
@ -11,9 +11,7 @@ order: 12
|
||||
|
||||
**默认值**：`0.2`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：管道半径
|
||||
管道半径
|
||||
|
||||
## ringRadius
|
||||
|
||||
@ -21,9 +19,7 @@ order: 12
|
||||
|
||||
**默认值**：`0.3`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：环半径
|
||||
环半径
|
||||
|
||||
## segments
|
||||
|
||||
@ -31,9 +27,7 @@ order: 12
|
||||
|
||||
**默认值**：`30`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：分段数
|
||||
分段数
|
||||
|
||||
## sides
|
||||
|
||||
@ -41,6 +35,4 @@ order: 12
|
||||
|
||||
**默认值**：`20`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：边数
|
||||
边数
|
||||
|
||||
@ -1,12 +1,10 @@
|
||||
## anchor
|
||||
|
||||
**Type**: `string` | `number[]`
|
||||
**Type**: `string | number[]`
|
||||
|
||||
**Default**: `[0, 0]`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The origin (anchor) position of the graphic, based on the bounding box definition, ranging from `[0, 0]` to `[1, 1]`, where `[0, 0]` represents the top-left corner of the bounding box, and `[1, 1]` represents the bottom-right corner
|
||||
The origin (anchor) position of the graphic, based on the bounding box definition, ranging from `[0, 0]` to `[1, 1]`, where `[0, 0]` represents the top-left corner of the bounding box, and `[1, 1]` represents the bottom-right corner
|
||||
|
||||
- Circle, Ellipse at the center position `[0.5, 0.5]`
|
||||
- Rect, Image, Line, Polyline, Polygon, Path at the top-left vertex position of the bounding box `[0, 0]`
|
||||
@ -19,9 +17,7 @@
|
||||
|
||||
**Default**: `''`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The value of the class attribute of the element. Multiple classes are separated by spaces
|
||||
The value of the class attribute of the element. Multiple classes are separated by spaces
|
||||
|
||||
## clipPath
|
||||
|
||||
@ -29,9 +25,7 @@
|
||||
|
||||
**Default**: `null`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Use clipping to create the displayable area of the element, where the part inside the area is displayed, and the part outside is hidden
|
||||
Use clipping to create the displayable area of the element, where the part inside the area is displayed, and the part outside is hidden
|
||||
|
||||
## cursor
|
||||
|
||||
@ -39,9 +33,7 @@
|
||||
|
||||
**Default**: `'default'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The style of the pointer when hovering over the element, optional values refer to: [CSS cursor](https://developer.mozilla.org/zh-CN/docs/Web/CSS/cursor)。
|
||||
The style of the pointer when hovering over the element, optional values refer to: [CSS cursor](https://developer.mozilla.org/zh-CN/docs/Web/CSS/cursor)。
|
||||
|
||||
## fill
|
||||
|
||||
@ -49,9 +41,7 @@
|
||||
|
||||
**Default**: `'none'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The color used to fill the shape
|
||||
The color used to fill the shape
|
||||
|
||||
## fillOpacity
|
||||
|
||||
@ -59,9 +49,7 @@
|
||||
|
||||
**Default**: `1`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The opacity of the shape's fill, with a value range of `[0, 1]`
|
||||
The opacity of the shape's fill, with a value range of `[0, 1]`
|
||||
|
||||
## fillRule
|
||||
|
||||
@ -69,9 +57,7 @@
|
||||
|
||||
**Default**: `'nonzero'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The rule for filling the shape
|
||||
The rule for filling the shape
|
||||
|
||||
## filter
|
||||
|
||||
@ -79,9 +65,7 @@
|
||||
|
||||
**Default**: `'none'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Filters can process an already generated image, such as blurring, highlighting, increasing contrast, etc
|
||||
Filters can process an already generated image, such as blurring, highlighting, increasing contrast, etc
|
||||
|
||||
- `CSS Filter`：https://developer.mozilla.org/en-US/docs/Web/CSS/filter
|
||||
- `Canvas Filter`：https://developer.mozilla.org/zh-CN/docs/Web/API/CanvasRenderingContext2D/filter
|
||||
@ -94,9 +78,7 @@
|
||||
|
||||
**Default**: `'butt'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The style of the endpoints of the shape's stroke
|
||||
The style of the endpoints of the shape's stroke
|
||||
|
||||
- `'butt'` Default value. The end of the line segment ends in a square
|
||||
- `'round'` The end of the line segment ends in a circle
|
||||
@ -108,9 +90,7 @@
|
||||
|
||||
**Default**: `[]`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The dash style of the shape's stroke, with values in the array alternating between dash length and spacing
|
||||
The dash style of the shape's stroke, with values in the array alternating between dash length and spacing
|
||||
|
||||
## lineDashOffset
|
||||
|
||||
@ -118,9 +98,7 @@
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The dash offset for the shape's stroke
|
||||
The dash offset for the shape's stroke
|
||||
|
||||
## lineJoin
|
||||
|
||||
@ -128,9 +106,7 @@
|
||||
|
||||
**Default**: `'miter'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The style of the stroke's joints
|
||||
The style of the stroke's joints
|
||||
|
||||
- `'miter'` Default value. By extending the outer edge of the connected part, it intersects at one point to form an additional rhombus area
|
||||
- `'round'` By filling an additional sector with the center at the end of the connected part, the shape of the corner is drawn. The radius of the rounded corner is the width of the line segment
|
||||
@ -142,9 +118,7 @@
|
||||
|
||||
**Default**: `1`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The width of the shape's stroke
|
||||
The width of the shape's stroke
|
||||
|
||||
## miterLimit
|
||||
|
||||
@ -152,9 +126,7 @@
|
||||
|
||||
**Default**: `10`(Canvas) `4`(SVG)
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: When lineJoin is set to 'miter', this sets the miter limit ratio
|
||||
When lineJoin is set to 'miter', this sets the miter limit ratio
|
||||
|
||||
## opacity
|
||||
|
||||
@ -162,19 +134,15 @@
|
||||
|
||||
**Default**: `1`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The opacity of the shape, with a value range of `[0, 1]`
|
||||
The opacity of the shape, with a value range of `[0, 1]`
|
||||
|
||||
## pointerEvents
|
||||
|
||||
**Type**: `'none'` | `'auto'` | `'stroke'` | `'fill'` | `'painted'` | `'visible'` | `'visiblestroke'` | `'visiblefill'` | `'visiblepainted'` | `'all'` | `'non-transparent-pixel'`
|
||||
**Type**: `'none' | 'auto' | 'stroke' | 'fill' | 'painted' | 'visible' | 'visiblestroke' | 'visiblefill' | 'visiblepainted' | 'all' | 'non-transparent-pixel'`
|
||||
|
||||
**Default**: `'auto'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: How the shape responds to interactive events, for reference: https://developer.mozilla.org/en-US/docs/Web/CSS/pointer-events
|
||||
How the shape responds to interactive events, for reference: https://developer.mozilla.org/en-US/docs/Web/CSS/pointer-events
|
||||
|
||||
## shadowBlur
|
||||
|
||||
@ -182,9 +150,7 @@
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The level of blur for the shadow, with higher values indicating more blur
|
||||
The level of blur for the shadow, with higher values indicating more blur
|
||||
|
||||
## shadowColor
|
||||
|
||||
@ -192,19 +158,15 @@
|
||||
|
||||
**Default**: `'none'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The color of the shadow
|
||||
The color of the shadow
|
||||
|
||||
## shadowType
|
||||
|
||||
**Type**: `'inner'` | `'outer'`
|
||||
**Type**: `'inner' | 'outer'`
|
||||
|
||||
**Default**: `'outer'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The type of shadow
|
||||
The type of shadow
|
||||
|
||||
- `'outer'` Outer shadow, the shadow is outside the shape's fill or stroke
|
||||
- `'inner'` Inner shadow, the shadow is inside the shape
|
||||
@ -215,9 +177,7 @@
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The offset of the shadow in the x-axis direction
|
||||
The offset of the shadow in the x-axis direction
|
||||
|
||||
## shadowOffsetY
|
||||
|
||||
@ -225,9 +185,7 @@
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The offset of the shadow in the y-axis direction
|
||||
The offset of the shadow in the y-axis direction
|
||||
|
||||
## stroke
|
||||
|
||||
@ -235,9 +193,7 @@
|
||||
|
||||
**Default**: `'none'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The color of the shape's stroke
|
||||
The color of the shape's stroke
|
||||
|
||||
## strokeOpacity
|
||||
|
||||
@ -245,9 +201,7 @@
|
||||
|
||||
**Default**: `1`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The opacity of the shape's stroke, with a value range of `[0, 1]`
|
||||
The opacity of the shape's stroke, with a value range of `[0, 1]`
|
||||
|
||||
## visibility
|
||||
|
||||
@ -255,9 +209,7 @@
|
||||
|
||||
**Default**: `'visible'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The visibility of the element
|
||||
The visibility of the element
|
||||
|
||||
## zIndex
|
||||
|
||||
@ -265,6 +217,4 @@
|
||||
|
||||
**Default**: `0`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The z-index of the element, with higher values being closer to the top
|
||||
The z-index of the element, with higher values being closer to the top
|
||||
|
||||
@ -1,12 +1,10 @@
|
||||
## anchor
|
||||
|
||||
**类型**：`string` | `number[]`
|
||||
**类型**：`string | number[]`
|
||||
|
||||
**默认值**：`[0, 0]`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图形的原点（锚点）位置，基于包围盒定义，取值范围 `[0, 0]` ~ `[1, 1]`，其中 `[0, 0]` 代表包围盒左上角，`[1, 1]` 代表右下角
|
||||
图形的原点（锚点）位置，基于包围盒定义，取值范围 `[0, 0]` ~ `[1, 1]`，其中 `[0, 0]` 代表包围盒左上角，`[1, 1]` 代表右下角
|
||||
|
||||
不同图形的默认锚点如下，示例：
|
||||
|
||||
@ -21,9 +19,7 @@
|
||||
|
||||
**默认值**：`''`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：元素的 class 属性的值，多个 class 用空格分隔
|
||||
元素的 class 属性的值，多个 class 用空格分隔
|
||||
|
||||
## clipPath
|
||||
|
||||
@ -31,9 +27,7 @@
|
||||
|
||||
**默认值**：`null`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：使用裁剪方式创建元素的可显示区域，区域内的部分显示，区域外的隐藏
|
||||
使用裁剪方式创建元素的可显示区域，区域内的部分显示，区域外的隐藏
|
||||
|
||||
## cursor
|
||||
|
||||
@ -41,9 +35,7 @@
|
||||
|
||||
**默认值**：`'default'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：指针悬停在元素上时的样式，可选值参考：[CSS cursor](https://developer.mozilla.org/zh-CN/docs/Web/CSS/cursor)
|
||||
指针悬停在元素上时的样式，可选值参考：[CSS cursor](https://developer.mozilla.org/zh-CN/docs/Web/CSS/cursor)
|
||||
|
||||
## fill
|
||||
|
||||
@ -51,9 +43,7 @@
|
||||
|
||||
**默认值**：`'none'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图形填充的颜色
|
||||
图形填充的颜色
|
||||
|
||||
## fillOpacity
|
||||
|
||||
@ -61,19 +51,15 @@
|
||||
|
||||
**默认值**：`1`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图形填充的透明度，取值范围为 `[0, 1]`
|
||||
图形填充的透明度，取值范围为 `[0, 1]`
|
||||
|
||||
## fillRule
|
||||
|
||||
**类型**：`'nonzero'` | `'evenodd'`
|
||||
**类型**：`'nonzero' | 'evenodd'`
|
||||
|
||||
**默认值**：`'nonzero'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图形填充的规则
|
||||
图形填充的规则
|
||||
|
||||
## filter
|
||||
|
||||
@ -81,9 +67,7 @@
|
||||
|
||||
**默认值**：`'none'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：滤镜可以对已生成的图像进行一些处理，例如模糊、高亮、提升对比度等
|
||||
滤镜可以对已生成的图像进行一些处理，例如模糊、高亮、提升对比度等
|
||||
|
||||
- `CSS Filter`：https://developer.mozilla.org/en-US/docs/Web/CSS/filter
|
||||
- `Canvas Filter`：https://developer.mozilla.org/zh-CN/docs/Web/API/CanvasRenderingContext2D/filter
|
||||
@ -92,13 +76,11 @@
|
||||
|
||||
## lineCap
|
||||
|
||||
**类型**：`'butt'` | `'round'` | `'square'`
|
||||
**类型**：`'butt' | 'round' | 'square'`
|
||||
|
||||
**默认值**：`'butt'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图形描边的端点样式
|
||||
图形描边的端点样式
|
||||
|
||||
- `'butt'` 线段末端以方形结束
|
||||
- `'round'` 线段末端以圆形结束
|
||||
@ -110,9 +92,7 @@
|
||||
|
||||
**默认值**：`[]`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图形描边的虚线样式，数组中的值依次为虚线长度，虚线间隔，虚线长度，虚线间隔，...
|
||||
图形描边的虚线样式，数组中的值依次为虚线长度，虚线间隔，虚线长度，虚线间隔，...
|
||||
|
||||
## lineDashOffset
|
||||
|
||||
@ -120,19 +100,15 @@
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图形描边的虚线偏移量
|
||||
图形描边的虚线偏移量
|
||||
|
||||
## lineJoin
|
||||
|
||||
**类型**：`'miter'` | `'round'` | `'bevel'`
|
||||
**类型**：`'miter' | 'round' | 'bevel'`
|
||||
|
||||
**默认值**：`'miter'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：连接处样式
|
||||
连接处样式
|
||||
|
||||
- `'miter'` 通过延伸相连部分的外边缘，使其相交于一点，形成一个额外的菱形区域
|
||||
- `'round'` 通过填充一个额外的，圆心在相连部分末端的扇形，绘制拐角的形状。 圆角的半径是线段的宽度
|
||||
@ -144,9 +120,7 @@
|
||||
|
||||
**默认值**：`1`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图形描边的宽度
|
||||
图形描边的宽度
|
||||
|
||||
## miterLimit
|
||||
|
||||
@ -154,9 +128,7 @@
|
||||
|
||||
**默认值**：`10`(Canvas) `4`(SVG)
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：当 lineJoin 为 'miter' 时，设置斜接面限制比例
|
||||
当 lineJoin 为 'miter' 时，设置斜接面限制比例
|
||||
|
||||
## opacity
|
||||
|
||||
@ -164,19 +136,15 @@
|
||||
|
||||
**默认值**：`1`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图形的透明度，取值范围为 `[0, 1]`
|
||||
图形的透明度，取值范围为 `[0, 1]`
|
||||
|
||||
## pointerEvents
|
||||
|
||||
**类型**：`'none'` | `'auto'` | `'stroke'` | `'fill'` | `'painted'` | `'visible'` | `'visiblestroke'` | `'visiblefill'` | `'visiblepainted'` | `'all'` | `'non-transparent-pixel'`
|
||||
**类型**：`'none' | 'auto' | 'stroke' | 'fill' | 'painted' | 'visible' | 'visiblestroke' | 'visiblefill' | 'visiblepainted' | 'all' | 'non-transparent-pixel'`
|
||||
|
||||
**默认值**：`'auto'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：设置图形如何响应交互事件，可参考：https://developer.mozilla.org/en-US/docs/Web/CSS/pointer-events
|
||||
设置图形如何响应交互事件，可参考：https://developer.mozilla.org/en-US/docs/Web/CSS/pointer-events
|
||||
|
||||
## shadowBlur
|
||||
|
||||
@ -184,9 +152,7 @@
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：阴影的模糊级别，值越大越模糊
|
||||
阴影的模糊级别，值越大越模糊
|
||||
|
||||
## shadowColor
|
||||
|
||||
@ -194,19 +160,15 @@
|
||||
|
||||
**默认值**：`'none'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：阴影的颜色
|
||||
阴影的颜色
|
||||
|
||||
## shadowType
|
||||
|
||||
**类型**：`'inner'` | `'outer'`
|
||||
**类型**：`'inner' | 'outer'`
|
||||
|
||||
**默认值**：`'outer'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：阴影类型
|
||||
阴影类型
|
||||
|
||||
- `'outer'` 外阴影，阴影在图形填充或者描边的外侧
|
||||
- `'inner'` 内阴影，阴影在图形内部
|
||||
@ -217,9 +179,7 @@
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：阴影在 x 轴方向的偏移量
|
||||
阴影在 x 轴方向的偏移量
|
||||
|
||||
## shadowOffsetY
|
||||
|
||||
@ -227,9 +187,7 @@
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：阴影在 y 轴方向的偏移量
|
||||
阴影在 y 轴方向的偏移量
|
||||
|
||||
## stroke
|
||||
|
||||
@ -237,9 +195,7 @@
|
||||
|
||||
**默认值**：`'none'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图形描边的颜色
|
||||
图形描边的颜色
|
||||
|
||||
## strokeOpacity
|
||||
|
||||
@ -247,19 +203,15 @@
|
||||
|
||||
**默认值**：`1`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：图形描边的透明度，取值范围为 `[0, 1]`
|
||||
图形描边的透明度，取值范围为 `[0, 1]`
|
||||
|
||||
## visibility
|
||||
|
||||
**类型**：`'visible'` | `'hidden'`
|
||||
**类型**：`'visible' | 'hidden'`
|
||||
|
||||
**默认值**：`'visible'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：元素的可见性
|
||||
元素的可见性
|
||||
|
||||
## zIndex
|
||||
|
||||
@ -267,6 +219,4 @@
|
||||
|
||||
**默认值**：`0`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：元素的层级，值越大越靠上
|
||||
元素的层级，值越大越靠上
|
||||
|
||||
@ -6,9 +6,7 @@
|
||||
|
||||
**Default**: `1000`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The max zoom
|
||||
The max zoom
|
||||
|
||||
## minZoom
|
||||
|
||||
@ -16,9 +14,7 @@
|
||||
|
||||
**Default**: `0.00001`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The min zoom
|
||||
The min zoom
|
||||
|
||||
<embed src="./BehaviorSecondaryKey.en.md"></embed>
|
||||
|
||||
@ -28,21 +24,17 @@
|
||||
|
||||
**Default**: `6`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The sensitivity of zoom
|
||||
The sensitivity of zoom
|
||||
|
||||
<embed src="./BehaviorShouldBegin.en.md"></embed>
|
||||
|
||||
## trigger
|
||||
|
||||
**Type**: `'wheel'` | `'upDownKeys'`
|
||||
**Type**: `'wheel' | 'upDownKeys'`
|
||||
|
||||
**Default**: `'wheel'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The way to trigger interaction
|
||||
The way to trigger interaction
|
||||
|
||||
## triggerOnItems
|
||||
|
||||
@ -50,6 +42,4 @@
|
||||
|
||||
**Default**: `true`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether trigger zoom on node/edge/combo
|
||||
Whether trigger zoom on node/edge/combo
|
||||
45
packages/site/docs/common/BaseZoomCanvasOptions.zh.md
Normal file
45
packages/site/docs/common/BaseZoomCanvasOptions.zh.md
Normal file
@ -0,0 +1,45 @@
|
||||
<embed src="./BehaviorEventName.zh.md"></embed>
|
||||
|
||||
## maxZoom
|
||||
|
||||
**类型**：`number`
|
||||
|
||||
**默认值**：`1000`
|
||||
|
||||
最大缩放比例
|
||||
|
||||
## minZoom
|
||||
|
||||
**类型**：`number`
|
||||
|
||||
**默认值**：`0.00001`
|
||||
|
||||
最小缩放比例
|
||||
|
||||
<embed src="./BehaviorSecondaryKey.zh.md"></embed>
|
||||
|
||||
## sensitivity
|
||||
|
||||
**类型**：`number`
|
||||
|
||||
**默认值**：`6`
|
||||
|
||||
缩放的灵敏度
|
||||
|
||||
<embed src="./BehaviorShouldBegin.zh.md"></embed>
|
||||
|
||||
## trigger
|
||||
|
||||
**类型**：`'wheel' | 'upDownKeys'`
|
||||
|
||||
**默认值**：`'wheel'`
|
||||
|
||||
触发交互的方式
|
||||
|
||||
## triggerOnItems
|
||||
|
||||
**类型**：`boolean`
|
||||
|
||||
**默认值**：`true`
|
||||
|
||||
是否在节点/边/Combo 上触发缩放
|
||||
@ -1,55 +0,0 @@
|
||||
<embed src="./BehaviorEventName.en.md"></embed>
|
||||
|
||||
## maxZoom
|
||||
|
||||
**类型**：`number`
|
||||
|
||||
**默认值**：`1000`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：最大缩放比例
|
||||
|
||||
## minZoom
|
||||
|
||||
**类型**：`number`
|
||||
|
||||
**默认值**：`0.00001`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：最小缩放比例
|
||||
|
||||
<embed src="./BehaviorSecondaryKey.zh.md"></embed>
|
||||
|
||||
## sensitivity
|
||||
|
||||
**类型**：`number`
|
||||
|
||||
**默认值**：`6`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：缩放的灵敏度
|
||||
|
||||
<embed src="./BehaviorShouldBegin.zh.md"></embed>
|
||||
|
||||
## trigger
|
||||
|
||||
**类型**：`'wheel'` | `'upDownKeys'`
|
||||
|
||||
**默认值**：`'wheel'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：触发交互的方式
|
||||
|
||||
## triggerOnItems
|
||||
|
||||
**类型**：`boolean`
|
||||
|
||||
**默认值**：`true`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否在节点/边/Combo 上触发缩放
|
||||
@ -33,9 +33,7 @@ type brushStyle = {
|
||||
|
||||
**Default**: `''`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The event name triggered when selected/deselected
|
||||
The event name triggered when selected/deselected
|
||||
|
||||
<embed src="./BehaviorItemTypes.en.md"></embed>
|
||||
|
||||
@ -72,19 +70,15 @@ type onSelect = (selectedIds: { nodes: ID[]; edges: ID[]; combos: ID[] }) => voi
|
||||
|
||||
**Default**: `'selected'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Switch to this state when highlighted
|
||||
Switch to this state when highlighted
|
||||
|
||||
## selectSetMode
|
||||
|
||||
**Type**: `'union'` | `'intersect'` | `'latest'` | `'latest'`
|
||||
**Type**: `'union' | 'intersect' | 'latest' | 'latest'`
|
||||
|
||||
**Default**: `'latest'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The mode of the select set
|
||||
The mode of the select set
|
||||
|
||||
<embed src="./BehaviorShouldBegin.zh.md"></embed>
|
||||
|
||||
@ -104,13 +98,11 @@ type shouldUpdate = (itemType: ITEM_TYPE, id: ID, action: 'select' | 'deselect',
|
||||
|
||||
## trigger
|
||||
|
||||
**Type**: `'shift'` | `'ctrl'` | `'alt'` | `'meta'` | `'drag'`
|
||||
**Type**: `'shift' | 'ctrl' | 'alt' | 'meta' | 'drag'`
|
||||
|
||||
**Default**: `'shift'`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The event type that triggers the interaction
|
||||
The event type that triggers the interaction
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -33,9 +33,7 @@ type brushStyle = {
|
||||
|
||||
**默认值**：`''`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：选中/取消选中时触发的事件名
|
||||
选中/取消选中时触发的事件名
|
||||
|
||||
<embed src="./BehaviorItemTypes.zh.md"></embed>
|
||||
|
||||
@ -72,19 +70,15 @@ type onSelect = (selectedIds: { nodes: ID[]; edges: ID[]; combos: ID[] }) => voi
|
||||
|
||||
**默认值**：`'selected'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：选中时切换到该状态
|
||||
选中时切换到该状态
|
||||
|
||||
## selectSetMode
|
||||
|
||||
**类型**：`'union'` | `'intersect'` | `'latest'` | `'latest'`
|
||||
**类型**：`'union' | 'intersect' | 'latest' | 'latest'`
|
||||
|
||||
**默认值**：`'latest'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：选区的选择模式
|
||||
选区的选择模式
|
||||
|
||||
<embed src="./BehaviorShouldBegin.zh.md"></embed>
|
||||
|
||||
@ -104,13 +98,11 @@ type shouldUpdate = (itemType: ITEM_TYPE, id: ID, action: 'select' | 'deselect',
|
||||
|
||||
## trigger
|
||||
|
||||
**类型**：`'shift'` | `'ctrl'` | `'alt'` | `'meta'` | `'drag'`
|
||||
**类型**：`'shift' | 'ctrl' | 'alt' | 'meta' | 'drag'`
|
||||
|
||||
**默认值**：`'shift'`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：触发交互的事件类型
|
||||
触发交互的事件类型
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -1,9 +1,7 @@
|
||||
## direction
|
||||
|
||||
**Type**: `'both'` | `'x'` | `'y'`
|
||||
**Type**: `'both' | 'x' | 'y'`
|
||||
|
||||
**Default**: `both`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The direction of interaction
|
||||
The direction of interaction
|
||||
@ -1,9 +1,7 @@
|
||||
## direction
|
||||
|
||||
**类型**：`'both'` | `'x'` | `'y'`
|
||||
**类型**：`'both' | 'x' | 'y'`
|
||||
|
||||
**默认值**：`both`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：交互方向
|
||||
交互方向
|
||||
@ -36,9 +36,7 @@ type delegateStyle = {
|
||||
|
||||
**Default**: `true`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to render the interaction target to the transient layer
|
||||
Whether to render the interaction target to the transient layer
|
||||
|
||||
## enableDelegate
|
||||
|
||||
@ -46,9 +44,7 @@ type delegateStyle = {
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to render a delegate rectangle shape when dragging
|
||||
Whether to render a delegate rectangle shape when dragging
|
||||
|
||||
<img alt="enable delegate" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*ajOlSJlLPpAAAAAAAAAAAAAADmJ7AQ/original
|
||||
" height='300'/>
|
||||
@ -59,9 +55,7 @@ type delegateStyle = {
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to hide the related edges when dragging
|
||||
Whether to hide the related edges when dragging
|
||||
|
||||
## selectedState
|
||||
|
||||
@ -69,9 +63,7 @@ type delegateStyle = {
|
||||
|
||||
**Default**: `selected`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Switch to this state when dragging
|
||||
Switch to this state when dragging
|
||||
|
||||
<embed src="./Throttle.en.md"></embed>
|
||||
|
||||
@ -81,8 +73,6 @@ type delegateStyle = {
|
||||
|
||||
**Default**: `true`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether to update the structure of the combo when dragging
|
||||
Whether to update the structure of the combo when dragging
|
||||
|
||||
<embed src="./BehaviorShouldBegin.en.md"></embed>
|
||||
|
||||
@ -36,9 +36,7 @@ type delegateStyle = {
|
||||
|
||||
**默认值**：`true`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否允将交互目标渲染到临时层(Transient Layer)
|
||||
是否允将交互目标渲染到临时层(Transient Layer)
|
||||
|
||||
## enableDelegate
|
||||
|
||||
@ -46,9 +44,7 @@ type delegateStyle = {
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：创建一个临时矩形来作为交互目标
|
||||
创建一个临时矩形来作为交互目标
|
||||
|
||||
<img alt="enable delegate" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*ajOlSJlLPpAAAAAAAAAAAAAADmJ7AQ/original
|
||||
" height='300'/>
|
||||
@ -59,9 +55,7 @@ type delegateStyle = {
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否隐藏与节点相关的边
|
||||
是否隐藏与节点相关的边
|
||||
|
||||
## selectedState
|
||||
|
||||
@ -69,9 +63,7 @@ type delegateStyle = {
|
||||
|
||||
**默认值**：`selected`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：拖拽时切换到该状态
|
||||
拖拽时切换到该状态
|
||||
|
||||
<embed src="./Throttle.zh.md"></embed>
|
||||
|
||||
@ -81,8 +73,6 @@ type delegateStyle = {
|
||||
|
||||
**默认值**：`true`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：拖拽过程中，是否更新 Combo 结构
|
||||
拖拽过程中，是否更新 Combo 结构
|
||||
|
||||
<embed src="./BehaviorShouldBegin.zh.md"></embed>
|
||||
|
||||
@ -4,6 +4,4 @@
|
||||
|
||||
**Default**: `false`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: Whether enable optimize strategies, which will hide all the shapes excluding node keyShape
|
||||
Whether enable optimize strategies, which will hide all the shapes excluding node keyShape
|
||||
@ -4,6 +4,4 @@
|
||||
|
||||
**默认值**：`false`
|
||||
|
||||
**是否必须**：false
|
||||
|
||||
**说明**：是否启用优化策略，这将在交互过程中仅显示关键图形
|
||||
是否启用优化策略，这将在交互过程中仅显示关键图形
|
||||
|
||||
@ -4,6 +4,4 @@
|
||||
|
||||
**Default**: `''`
|
||||
|
||||
**Required**: false
|
||||
|
||||
**Description**: The event after interaction
|
||||
The event after interaction
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user