2023-08-31 21:44:58 +08:00
|
|
|
---
|
|
|
|
|
title: ModelRectNode
|
|
|
|
|
---
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
> 📋 中文文档还在翻译中... 欢迎 PR
|
2023-08-31 22:06:26 +08:00
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
[Overview - v5.0.0-beta.2](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / ModelRectNode
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
[item](../../modules/item.zh.md).ModelRectNode
|
|
|
|
|
|
|
|
|
|
## Hierarchy
|
|
|
|
|
|
|
|
|
|
- [`CustomNode`](CustomNode.zh.md)
|
|
|
|
|
|
|
|
|
|
↳ **`ModelRectNode`**
|
|
|
|
|
|
|
|
|
|
## Constructors
|
|
|
|
|
|
|
|
|
|
### constructor
|
|
|
|
|
|
|
|
|
|
• **new ModelRectNode**(`props`)
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type |
|
|
|
|
|
| :------ | :---- |
|
2023-08-31 21:44:58 +08:00
|
|
|
| `props` | `any` |
|
|
|
|
|
|
|
|
|
|
#### Overrides
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[constructor](CustomNode.zh.md#constructor)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/modelRect.ts:42](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/modelRect.ts#L42)
|
|
|
|
|
|
|
|
|
|
## Methods
|
|
|
|
|
|
|
|
|
|
### afterDraw
|
|
|
|
|
|
|
|
|
|
▸ **afterDraw**(`model`, `shapeMap`, `shapesChanged?`): `Object`
|
|
|
|
|
|
|
|
|
|
Perform additional drawing operations or add custom shapes after drawing node.
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :--------------- | :---------------------------------------- | :---------------------------------------------------------------------------- |
|
|
|
|
|
| `model` | `NodeDisplayModel` \| `ComboDisplayModel` | The displayed model of this node, only for drawing and not received by users. |
|
|
|
|
|
| `shapeMap` | `Object` | The shape map that contains all of the elements to show on the node. |
|
|
|
|
|
| `shapesChanged?` | `string`[] | An array of shape IDs that have changed and need to be updated. |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`Object`
|
|
|
|
|
|
|
|
|
|
An object that contains some new shapes to be added to the node.
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[afterDraw](CustomNode.zh.md#afterdraw)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:230](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L230)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### calculateAnchorPosition
|
|
|
|
|
|
|
|
|
|
▸ **calculateAnchorPosition**(`keyShapeStyle`): [`IAnchorPositionMap`](../../interfaces/item/IAnchorPositionMap.zh.md)
|
|
|
|
|
|
|
|
|
|
Configures the anchor positions based on the provided keyShapeStyle and returns the configuration.
|
|
|
|
|
e.g for a CircleNode, it returns: `{"right":keyShapeStyle.x+keyShapeStyle.r, keyShapeStyle.y}`
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :-------------- | :---- | :----------------------------------------------------------------------------- |
|
2023-08-31 21:44:58 +08:00
|
|
|
| `keyShapeStyle` | `any` | The keyShapeStyle object that contains the style information of the key shape. |
|
|
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
[`IAnchorPositionMap`](../../interfaces/item/IAnchorPositionMap.zh.md)
|
|
|
|
|
|
|
|
|
|
The anchor position configuration as an IAnchorPositionMap object.
|
|
|
|
|
|
|
|
|
|
#### Overrides
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[calculateAnchorPosition](CustomNode.zh.md#calculateanchorposition)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/modelRect.ts:117](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/modelRect.ts#L117)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### draw
|
|
|
|
|
|
|
|
|
|
▸ **draw**(`model`, `shapeMap`, `diffData?`, `diffState?`): `NodeShapeMap`
|
|
|
|
|
|
|
|
|
|
Draw all elements related to the node.
|
|
|
|
|
You should call `drawKeyShape` and `drawAnchorShape`,`drawLabelShape`,`drawIconShape`...as you like.
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :------------------- | :------------------------------------------------------------------- | :---------------------------------------------------------------------------- |
|
|
|
|
|
| `model` | `NodeDisplayModel` | The displayed model of this node, only for drawing and not received by users. |
|
|
|
|
|
| `shapeMap` | `NodeShapeMap` | The shape map that contains all of the elements to show on the node. |
|
|
|
|
|
| `diffData?` | `Object` | An object that contains previous and current data. |
|
|
|
|
|
| `diffData.current` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) | - |
|
|
|
|
|
| `diffData.previous` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) | - |
|
|
|
|
|
| `diffState?` | `Object` | An object that contains previous and current node's state. |
|
|
|
|
|
| `diffState.current` | `State`[] | - |
|
|
|
|
|
| `diffState.previous` | `State`[] | - |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`NodeShapeMap`
|
|
|
|
|
|
|
|
|
|
An object containing the keyShape and optional labelShape, iconShape, and some otherShapes properties
|
|
|
|
|
|
|
|
|
|
#### Overrides
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[draw](CustomNode.zh.md#draw)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/modelRect.ts:47](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/modelRect.ts#L47)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### drawAnchorShapes
|
|
|
|
|
|
|
|
|
|
▸ **drawAnchorShapes**(`model`, `shapeMap`, `diffData?`, `diffState?`): `Object`
|
|
|
|
|
|
|
|
|
|
Draw the anchors shape of the node
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :------------------- | :--------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- |
|
|
|
|
|
| `model` | `NodeDisplayModel` \| `ComboDisplayModel` | The displayed model of this node, only for drawing and not received by users. |
|
|
|
|
|
| `shapeMap` | `NodeShapeMap` | The shape map that contains all of the elements to show on the node. |
|
|
|
|
|
| `diffData?` | `Object` | An object that contains previous and current data. |
|
|
|
|
|
| `diffData.current` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffData.previous` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffState?` | `Object` | An object that contains previous and current node's state. |
|
|
|
|
|
| `diffState.current` | `State`[] | - |
|
|
|
|
|
| `diffState.previous` | `State`[] | - |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`Object`
|
|
|
|
|
|
|
|
|
|
The display object representing the anchors shape of the node.
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[drawAnchorShapes](CustomNode.zh.md#drawanchorshapes)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:534](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L534)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### drawBadgeShapes
|
|
|
|
|
|
|
|
|
|
▸ **drawBadgeShapes**(`model`, `shapeMap`, `diffData?`, `diffState?`): `Object`
|
|
|
|
|
|
|
|
|
|
Draw the badges shape of the node
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :------------------- | :--------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- |
|
|
|
|
|
| `model` | `NodeDisplayModel` \| `ComboDisplayModel` | The displayed model of this node, only for drawing and not received by users. |
|
|
|
|
|
| `shapeMap` | `NodeShapeMap` | The shape map that contains all of the elements to show on the node. |
|
|
|
|
|
| `diffData?` | `Object` | An object that contains previous and current data. |
|
|
|
|
|
| `diffData.current` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffData.previous` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffState?` | `Object` | An object that contains previous and current node's state. |
|
|
|
|
|
| `diffState.current` | `State`[] | - |
|
|
|
|
|
| `diffState.previous` | `State`[] | - |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`Object`
|
|
|
|
|
|
|
|
|
|
The display object representing the badges shape of the node.
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[drawBadgeShapes](CustomNode.zh.md#drawbadgeshapes)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:632](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L632)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### drawHaloShape
|
|
|
|
|
|
|
|
|
|
▸ **drawHaloShape**(`model`, `shapeMap`, `diffData?`, `diffState?`): `DisplayObject`<`any`, `any`\>
|
|
|
|
|
|
|
|
|
|
Draw the halo shape of the node
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :------------------- | :--------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- |
|
|
|
|
|
| `model` | `NodeDisplayModel` \| `ComboDisplayModel` | The displayed model of this node, only for drawing and not received by users. |
|
|
|
|
|
| `shapeMap` | `NodeShapeMap` | The shape map that contains all of the elements to show on the node. |
|
|
|
|
|
| `diffData?` | `Object` | An object that contains previous and current data. |
|
|
|
|
|
| `diffData.current` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffData.previous` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffState?` | `Object` | An object that contains previous and current node's state. |
|
|
|
|
|
| `diffState.current` | `State`[] | - |
|
|
|
|
|
| `diffState.previous` | `State`[] | - |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`DisplayObject`<`any`, `any`\>
|
|
|
|
|
|
|
|
|
|
The display object representing the halo shape of the node.
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[drawHaloShape](CustomNode.zh.md#drawhaloshape)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:494](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L494)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### drawIconShape
|
|
|
|
|
|
|
|
|
|
▸ **drawIconShape**(`model`, `shapeMap`, `diffData?`, `diffState?`): `DisplayObject`<`any`, `any`\>
|
|
|
|
|
|
|
|
|
|
Draw the icon shape of the node
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :------------------- | :--------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- |
|
|
|
|
|
| `model` | `NodeDisplayModel` \| `ComboDisplayModel` | The displayed model of this node, only for drawing and not received by users. |
|
|
|
|
|
| `shapeMap` | `NodeShapeMap` | The shape map that contains all of the elements to show on the node. |
|
|
|
|
|
| `diffData?` | `Object` | An object that contains previous and current data. |
|
|
|
|
|
| `diffData.current` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffData.previous` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffState?` | `Object` | An object that contains previous and current node's state. |
|
|
|
|
|
| `diffState.current` | `State`[] | - |
|
|
|
|
|
| `diffState.previous` | `State`[] | - |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`DisplayObject`<`any`, `any`\>
|
|
|
|
|
|
|
|
|
|
The display object representing the icon shape of the node.
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[drawIconShape](CustomNode.zh.md#drawiconshape)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:443](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L443)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### drawKeyShape
|
|
|
|
|
|
|
|
|
|
▸ **drawKeyShape**(`model`, `shapeMap`, `diffData?`, `diffState?`): `DisplayObject`<`any`, `any`\>
|
|
|
|
|
|
|
|
|
|
The key function of drawing shape.
|
|
|
|
|
Draw the key shape of the node based on the provided model and shape map.
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :------------------- | :------------------------------------------------------------------- | :---------------------------------------------------------------------------- |
|
|
|
|
|
| `model` | `NodeDisplayModel` | The displayed model of this node, only for drawing and not received by users. |
|
|
|
|
|
| `shapeMap` | `NodeShapeMap` | The shape map that contains all of the elements to show on the node. |
|
|
|
|
|
| `diffData?` | `Object` | An object that contains previous and current data. |
|
|
|
|
|
| `diffData.current` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) | - |
|
|
|
|
|
| `diffData.previous` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) | - |
|
|
|
|
|
| `diffState?` | `Object` | An object that contains previous and current node's state. |
|
|
|
|
|
| `diffState.current` | `State`[] | - |
|
|
|
|
|
| `diffState.previous` | `State`[] | - |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`DisplayObject`<`any`, `any`\>
|
|
|
|
|
|
|
|
|
|
The display object representing the key shape of the node.
|
|
|
|
|
|
|
|
|
|
#### Overrides
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[drawKeyShape](CustomNode.zh.md#drawkeyshape)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/modelRect.ts:97](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/modelRect.ts#L97)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### drawLabelBackgroundShape
|
|
|
|
|
|
|
|
|
|
▸ **drawLabelBackgroundShape**(`model`, `shapeMap`, `diffData?`, `diffState?`): `DisplayObject`<`any`, `any`\>
|
|
|
|
|
|
|
|
|
|
Draw the label background shape of the node
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :------------------- | :--------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- |
|
|
|
|
|
| `model` | `NodeDisplayModel` \| `ComboDisplayModel` | The displayed model of this node, only for drawing and not received by users. |
|
|
|
|
|
| `shapeMap` | `NodeShapeMap` | The shape map that contains all of the elements to show on the node. |
|
|
|
|
|
| `diffData?` | `Object` | An object that contains previous and current data. |
|
|
|
|
|
| `diffData.current` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffData.previous` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffState?` | `Object` | An object that contains previous and current node's state. |
|
|
|
|
|
| `diffState.newState` | `State`[] | - |
|
|
|
|
|
| `diffState.oldState` | `State`[] | - |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`DisplayObject`<`any`, `any`\>
|
|
|
|
|
|
|
|
|
|
The display object representing the label background shape of the node.
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[drawLabelBackgroundShape](CustomNode.zh.md#drawlabelbackgroundshape)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:386](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L386)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### drawLabelShape
|
|
|
|
|
|
|
|
|
|
▸ **drawLabelShape**(`model`, `shapeMap`, `diffData?`, `diffState?`): `DisplayObject`<`any`, `any`\>
|
|
|
|
|
|
|
|
|
|
Draw the label shape of the node
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :------------------- | :--------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- |
|
|
|
|
|
| `model` | `NodeDisplayModel` \| `ComboDisplayModel` | The displayed model of this node, only for drawing and not received by users. |
|
|
|
|
|
| `shapeMap` | `NodeShapeMap` | The shape map that contains all of the elements to show on the node. |
|
|
|
|
|
| `diffData?` | `Object` | An object that contains previous and current data. |
|
|
|
|
|
| `diffData.current` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffData.previous` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffState?` | `Object` | An object that contains previous and current node's state. |
|
|
|
|
|
| `diffState.current` | `State`[] | - |
|
|
|
|
|
| `diffState.previous` | `State`[] | - |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`DisplayObject`<`any`, `any`\>
|
|
|
|
|
|
|
|
|
|
The display object representing the label shape of the node.
|
|
|
|
|
|
|
|
|
|
#### Overrides
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[drawLabelShape](CustomNode.zh.md#drawlabelshape)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/modelRect.ts:136](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/modelRect.ts#L136)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### drawOtherShapes
|
|
|
|
|
|
|
|
|
|
▸ **drawOtherShapes**(`model`, `shapeMap`, `diffData?`, `diffState?`): `Object`
|
|
|
|
|
|
|
|
|
|
Draw other shapes(such as preRect,stateIcon) of the node
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :------------------- | :--------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- |
|
|
|
|
|
| `model` | `NodeDisplayModel` \| `ComboDisplayModel` | The displayed model of this node, only for drawing and not received by users. |
|
|
|
|
|
| `shapeMap` | `NodeShapeMap` | The shape map that contains all of the elements to show on the node. |
|
|
|
|
|
| `diffData?` | `Object` | An object that contains previous and current data. |
|
|
|
|
|
| `diffData.current` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffData.previous` | [`NodeUserModelData`](../../interfaces/item/NodeUserModelData.zh.md) \| `ComboModelData` | - |
|
|
|
|
|
| `diffState?` | `Object` | An object that contains previous and current node's state. |
|
|
|
|
|
| `diffState.current` | `State`[] | - |
|
|
|
|
|
| `diffState.previous` | `State`[] | - |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`Object`
|
|
|
|
|
|
|
|
|
|
The display object representing the other shapes of the node.
|
|
|
|
|
|
|
|
|
|
#### Overrides
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[drawOtherShapes](CustomNode.zh.md#drawothershapes)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/modelRect.ts:187](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/modelRect.ts#L187)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### getMergedStyles
|
|
|
|
|
|
|
|
|
|
▸ **getMergedStyles**(`model`): [`NodeShapeStyles`](../../interfaces/item/NodeShapeStyles.zh.md)
|
|
|
|
|
|
|
|
|
|
Merge style
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :------ | :---------------------------------------- | :---------------------------------------------------------------------------- |
|
2023-08-31 21:44:58 +08:00
|
|
|
| `model` | `NodeDisplayModel` \| `ComboDisplayModel` | The NodeDisplayModel or ComboDisplayModel to retrieve the merged styles from. |
|
|
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
[`NodeShapeStyles`](../../interfaces/item/NodeShapeStyles.zh.md)
|
|
|
|
|
|
|
|
|
|
The merged styles as a NodeShapeStyles object.
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[getMergedStyles](CustomNode.zh.md#getmergedstyles)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:113](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L113)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### mergeStyles
|
|
|
|
|
|
|
|
|
|
▸ **mergeStyles**(`model`): `void`
|
|
|
|
|
|
|
|
|
|
Get merged styles from `getMergedStyles` and assigns the merged styles to the 'mergedStyles' property.
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :------ | :---------------------------------------- | :------------------------------------------------------------------ |
|
2023-08-31 21:44:58 +08:00
|
|
|
| `model` | `NodeDisplayModel` \| `ComboDisplayModel` | The NodeDisplayModel or ComboDisplayModel to merge the styles from. |
|
|
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`void`
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[mergeStyles](CustomNode.zh.md#mergestyles)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:104](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L104)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### onZoom
|
|
|
|
|
|
|
|
|
|
▸ **onZoom**(`shapeMap`, `zoom`): `void`
|
|
|
|
|
|
|
|
|
|
The listener for graph zooming.
|
2023-08-31 23:46:08 +08:00
|
|
|
|
2023-08-31 21:44:58 +08:00
|
|
|
1. show / hide some shapes while zoom level changed;
|
|
|
|
|
2. change the shapes' sizes to make them have same visual size while zooming, e.g. labelShape, labelBackgroundShape.
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :--------- | :------------- | :------------------------------------------------------------------- |
|
2023-08-31 21:44:58 +08:00
|
|
|
| `shapeMap` | `NodeShapeMap` | The shape map that contains all of the elements to show on the node. |
|
2023-08-31 23:46:08 +08:00
|
|
|
| `zoom` | `number` | The zoom level of the graph. |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`void`
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[onZoom](CustomNode.zh.md#onzoom)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:814](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L814)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### updateCache
|
|
|
|
|
|
|
|
|
|
▸ **updateCache**(`shapeMap`): `void`
|
|
|
|
|
|
|
|
|
|
Call it after calling draw function to update cache about bounds and zoom levels.
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :--------- | :---- | :------------------------------------------------------------------- |
|
2023-08-31 21:44:58 +08:00
|
|
|
| `shapeMap` | `any` | The shape map that contains all of the elements to show on the node. |
|
|
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`void`
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[updateCache](CustomNode.zh.md#updatecache)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:164](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L164)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### upsertShape
|
|
|
|
|
|
|
|
|
|
▸ **upsertShape**(`type`, `id`, `style`, `shapeMap`, `model`): `DisplayObject`<`any`, `any`\>
|
|
|
|
|
|
|
|
|
|
Create (if does not exit in shapeMap) or update the shape according to the configurations.
|
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :--------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------- |
|
|
|
|
|
| `type` | `SHAPE_TYPE` \| `SHAPE_TYPE_3D` | shape's type |
|
|
|
|
|
| `id` | `string` | unique string to indicates the shape |
|
|
|
|
|
| `style` | `Partial`<[`CircleStyleProps`](../../interfaces/item/CircleStyleProps.zh.md) & [`RectStyleProps`](../../interfaces/item/RectStyleProps.zh.md) & [`EllipseStyleProps`](../../interfaces/item/EllipseStyleProps.zh.md) & [`PolygonStyleProps`](../../interfaces/item/PolygonStyleProps.zh.md) & [`LineStyleProps`](../../interfaces/item/LineStyleProps.zh.md) & [`PolylineStyleProps`](../../interfaces/item/PolylineStyleProps.zh.md) & [`TextStyleProps`](../../interfaces/item/TextStyleProps.zh.md) & [`ImageStyleProps`](../../interfaces/item/ImageStyleProps.zh.md) & [`PathStyleProps`](../../interfaces/item/PathStyleProps.zh.md) & [`SphereGeometryProps`](../../interfaces/item/SphereGeometryProps.zh.md) & [`CubeGeometryProps`](../../interfaces/item/CubeGeometryProps.zh.md) & [`PlaneGeometryProps`](../../interfaces/item/PlaneGeometryProps.zh.md) & { `interactive?`: `boolean` } & { `animates?`: `IAnimates` ; `lod?`: `number` ; `visible?`: `boolean` }\> | style to be updated |
|
|
|
|
|
| `shapeMap` | `NodeShapeMap` | the shape map of a node / combo |
|
|
|
|
|
| `model` | `NodeDisplayModel` \| `ComboDisplayModel` | data model of the node / combo |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
|
|
`DisplayObject`<`any`, `any`\>
|
|
|
|
|
|
|
|
|
|
The display object representing the shape.
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[upsertShape](CustomNode.zh.md#upsertshape)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:987](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L987)
|
|
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
|
|
|
|
|
### boundsCache
|
|
|
|
|
|
|
|
|
|
• **boundsCache**: `Object`
|
|
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type |
|
|
|
|
|
| :-------------------- | :----- |
|
|
|
|
|
| `keyShapeLocal?` | `AABB` |
|
2023-08-31 21:44:58 +08:00
|
|
|
| `labelShapeGeometry?` | `AABB` |
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[boundsCache](CustomNode.zh.md#boundscache)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:44](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L44)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### defaultStyles
|
|
|
|
|
|
|
|
|
|
• **defaultStyles**: `Object`
|
|
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type |
|
|
|
|
|
| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
|
|
|
| `keyShape` | { `fill`: `string` = 'white'; `height`: `number` = 70; `radius`: `number` = 2; `stroke`: `string` = '#C0DCEA'; `strokeWidth`: `string` = '2'; `width`: `number` = 185; `x`: `number` = 0; `y`: `number` = 0 } |
|
|
|
|
|
| `keyShape.fill` | `string` |
|
|
|
|
|
| `keyShape.height` | `number` |
|
|
|
|
|
| `keyShape.radius` | `number` |
|
|
|
|
|
| `keyShape.stroke` | `string` |
|
|
|
|
|
| `keyShape.strokeWidth` | `string` |
|
|
|
|
|
| `keyShape.width` | `number` |
|
|
|
|
|
| `keyShape.x` | `number` |
|
|
|
|
|
| `keyShape.y` | `number` |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Overrides
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[defaultStyles](CustomNode.zh.md#defaultstyles)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/modelRect.ts:25](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/modelRect.ts#L25)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### lodStrategy
|
|
|
|
|
|
|
|
|
|
• `Optional` **lodStrategy**: `LodStrategyObj`
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[lodStrategy](CustomNode.zh.md#lodstrategy)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:43](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L43)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### logoHeight
|
|
|
|
|
|
|
|
|
|
• **logoHeight**: `number`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/modelRect.ts:41](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/modelRect.ts#L41)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### logoWidth
|
|
|
|
|
|
|
|
|
|
• **logoWidth**: `number`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/modelRect.ts:40](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/modelRect.ts#L40)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### logoX
|
|
|
|
|
|
|
|
|
|
• **logoX**: `number`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/modelRect.ts:38](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/modelRect.ts#L38)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### logoY
|
|
|
|
|
|
|
|
|
|
• **logoY**: `number`
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/modelRect.ts:39](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/modelRect.ts#L39)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### mergedStyles
|
|
|
|
|
|
|
|
|
|
• **mergedStyles**: [`NodeShapeStyles`](../../interfaces/item/NodeShapeStyles.zh.md)
|
|
|
|
|
|
|
|
|
|
#### Overrides
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[mergedStyles](CustomNode.zh.md#mergedstyles)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/modelRect.ts:37](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/modelRect.ts#L37)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### setState
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
• **setState**: (`name`: `string`, `value`: `boolean`, `shapeMap`: { `[shapeId: string]`: `DisplayObject`; }) => `void`
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
|
|
▸ (`name`, `value`, `shapeMap`): `void`
|
|
|
|
|
|
|
|
|
|
Set the state for the node.
|
|
|
|
|
|
|
|
|
|
##### Parameters
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
| Name | Type | Description |
|
|
|
|
|
| :--------- | :-------- | :------------------------------------------------------------------- |
|
|
|
|
|
| `name` | `string` | - |
|
|
|
|
|
| `value` | `boolean` | state value |
|
|
|
|
|
| `shapeMap` | `Object` | The shape map that contains all of the elements to show on the node. |
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
##### Returns
|
|
|
|
|
|
|
|
|
|
`void`
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[setState](CustomNode.zh.md#setstate)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:245](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L245)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### themeStyles
|
|
|
|
|
|
|
|
|
|
• **themeStyles**: [`NodeShapeStyles`](../../interfaces/item/NodeShapeStyles.zh.md) \| `ComboShapeStyles`
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[themeStyles](CustomNode.zh.md#themestyles)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:41](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L41)
|
|
|
|
|
|
2023-08-31 23:46:08 +08:00
|
|
|
---
|
2023-08-31 21:44:58 +08:00
|
|
|
|
|
|
|
|
### type
|
|
|
|
|
|
|
|
|
|
• **type**: `string`
|
|
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
|
|
[CustomNode](CustomNode.zh.md).[type](CustomNode.zh.md#type)
|
|
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
|
|
|
|
|
[packages/g6/src/stdlib/item/node/base.ts:39](https://github.com/antvis/G6/blob/61e525e59b/packages/g6/src/stdlib/item/node/base.ts#L39)
|
