g6/WIP-CustomNode3D.en.md at 70daaf85c2934d602f5ab73f5f9eaa973952a5d1

test/g6

mirror of https://gitee.com/antv/g6.git synced 2024-12-03 04:08:32 +08:00

Yanyan-Wang 1e3a800da9 docs: update v5 docs

2023-11-07 21:39:59 +08:00

35 KiB

Raw Blame History

title
CustomNode3D

Overview - v5.0.0-beta.21 / Modules / item / CustomNode3D

item.CustomNode3D

Hierarchy

CustomNode

↳ CustomNode3D

↳↳ SphereNode

Constructors

constructor

• new CustomNode3D(props)

Parameters

Name	Type
`props`	`any`

Overrides

CustomNode.constructor

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:24

Methods

afterDraw

▸ afterDraw(model, shapeMap, shapesChanged?): Object

Perform additional drawing operations or add custom shapes after drawing node.

Parameters

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.

Returns

Object

An object that contains some new shapes to be added to the node.

Inherited from

CustomNode.afterDraw

Defined in

packages/g6/src/stdlib/item/node/base.ts:230

calculateAnchorPosition

▸ calculateAnchorPosition(keyShapeStyle): IAnchorPositionMap

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

Name	Type	Description
`keyShapeStyle`	`any`	The keyShapeStyle object that contains the style information of the key shape.

Returns

IAnchorPositionMap

The anchor position configuration as an IAnchorPositionMap object.

Inherited from

CustomNode.calculateAnchorPosition

Defined in

packages/g6/src/stdlib/item/node/base.ts:612

draw

▸ Abstract draw(model, shapeMap, diffData?, diffState?): Object

Draw all elements related to the node. You should call drawKeyShape and drawAnchorShape,drawLabelShape,drawIconShape...as you like.

Parameters

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.
`diffData?`	`Object`	An object that contains previous and current data.
`diffData.current`	`NodeUserModelData` \| `ComboModelData`	-
`diffData.previous`	`NodeUserModelData` \| `ComboModelData`	-
`diffState?`	`Object`	An object that contains previous and current node's state.
`diffState.current`	`State`[]	-
`diffState.previous`	`State`[]	-

Returns

Object

An object containing the keyShape and optional labelShape, iconShape, and some otherShapes properties

Name	Type
`iconShape?`	`DisplayObject`<`any`, `any`>
`keyShape`	`DisplayObject`<`any`, `any`>
`labelShape?`	`DisplayObject`<`any`, `any`>

Inherited from

CustomNode.draw

Defined in

packages/g6/src/stdlib/item/node/base.ts:208

drawAnchorShapes

▸ drawAnchorShapes(model, shapeMap, diffData?, diffState?): Object

3D node does not support anchor shapes.

Parameters

Name	Type
`model`	`NodeDisplayModel`
`shapeMap`	`NodeShapeMap`
`diffData?`	`Object`
`diffData.current`	`NodeUserModelData`
`diffData.previous`	`NodeUserModelData`
`diffState?`	`Object`
`diffState.current`	`State`[]
`diffState.previous`	`State`[]

Returns

Object

Overrides

CustomNode.drawAnchorShapes

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:160

drawBadgeShapes

▸ drawBadgeShapes(model, shapeMap, diffData?, diffState?): Object

Draw the badges shape of the node

Parameters

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`	-
`diffData.previous`	`NodeUserModelData`	-
`diffState?`	`Object`	An object that contains previous and current node's state.
`diffState.current`	`State`[]	-
`diffState.previous`	`State`[]	-

Returns

Object

The display object representing the badges shape of the node.

Overrides

CustomNode.drawBadgeShapes

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:171

drawHaloShape

▸ drawHaloShape(model, shapeMap, diffData?, diffState?): DisplayObject<any, any>

Draw the halo shape of the node

Parameters

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`	-
`diffData.previous`	`NodeUserModelData`	-
`diffState?`	`Object`	An object that contains previous and current node's state.
`diffState.current`	`State`[]	-
`diffState.previous`	`State`[]	-

Returns

DisplayObject<any, any>

The display object representing the halo shape of the node.

Overrides

CustomNode.drawHaloShape

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:130

drawIconShape

▸ drawIconShape(model, shapeMap, diffData?, diffState?): DisplayObject<any, any>

Draw the icon shape of the 3D node

Parameters

Name	Type	Description
`model`	`NodeDisplayModel`	The displayed model of this 3D node, only for drawing and not received by users.
`shapeMap`	`NodeShapeMap`	The shape map that contains all of the elements to show on the 3D node.
`diffData?`	`Object`	An object that contains previous and current data.
`diffData.current`	`NodeUserModelData`	-
`diffData.previous`	`NodeUserModelData`	-
`diffState?`	`Object`	An object that contains previous and current 3D node's state.
`diffState.current`	`State`[]	-
`diffState.previous`	`State`[]	-

Returns

DisplayObject<any, any>

The display object representing the icon shape of the 3D node.

Overrides

CustomNode.drawIconShape

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:120

drawKeyShape

▸ Abstract 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

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` \| `ComboModelData`	-
`diffData.previous`	`NodeUserModelData` \| `ComboModelData`	-
`diffState?`	`Object`	An object that contains previous and current node's state.
`diffState.current`	`State`[]	-
`diffState.previous`	`State`[]	-

Returns

DisplayObject<any, any>

The display object representing the key shape of the node.

Inherited from

CustomNode.drawKeyShape

Defined in

packages/g6/src/stdlib/item/node/base.ts:260

drawLabelBackgroundShape

▸ drawLabelBackgroundShape(model, shapeMap, diffData?, diffState?): DisplayObject<any, any>

Draw the label background shape of the node

Parameters

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` \| `ComboModelData`	-
`diffData.previous`	`NodeUserModelData` \| `ComboModelData`	-
`diffState?`	`Object`	An object that contains previous and current node's state.
`diffState.newState`	`State`[]	-
`diffState.oldState`	`State`[]	-

Returns

DisplayObject<any, any>

The display object representing the label background shape of the node.

Inherited from

CustomNode.drawLabelBackgroundShape

Defined in

packages/g6/src/stdlib/item/node/base.ts:386

drawLabelShape

▸ drawLabelShape(model, shapeMap, diffData?, diffState?): DisplayObject<any, any>

Draw the label shape of the 3D node

Parameters

Name	Type	Description
`model`	`NodeDisplayModel`	The displayed model of this 3D node, only for drawing and not received by users.
`shapeMap`	`NodeShapeMap`	The shape map that contains all of the elements to show on the 3D node.
`diffData?`	`Object`	An object that contains previous and current data.
`diffData.current`	`NodeUserModelData`	-
`diffData.previous`	`NodeUserModelData`	-
`diffState?`	`Object`	An object that contains previous and current 3D node's state.
`diffState.current`	`State`[]	-
`diffState.previous`	`State`[]	-

Returns

DisplayObject<any, any>

The display object representing the label shape of the 3D node.

Overrides

CustomNode.drawLabelShape

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:37

drawOtherShapes

▸ drawOtherShapes(model, shapeMap, diffData?, diffState?): Object

Draw other shapes(such as preRect,stateIcon) of the node

Parameters

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`	-
`diffData.previous`	`NodeUserModelData`	-
`diffState?`	`Object`	An object that contains previous and current node's state.
`diffState.current`	`State`[]	-
`diffState.previous`	`State`[]	-

Returns

Object

The display object representing the other shapes of the node.

Overrides

CustomNode.drawOtherShapes

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:183

getMergedStyles

▸ getMergedStyles(model): NodeShapeStyles

Merge style

Parameters

Name	Type	Description
`model`	`NodeDisplayModel` \| `ComboDisplayModel`	The NodeDisplayModel or ComboDisplayModel to retrieve the merged styles from.

Returns

NodeShapeStyles

The merged styles as a NodeShapeStyles object.

Inherited from

CustomNode.getMergedStyles

Defined in

packages/g6/src/stdlib/item/node/base.ts:113

mergeStyles

▸ mergeStyles(model): void

Get merged styles from getMergedStyles and assigns the merged styles to the 'mergedStyles' property.

Parameters

Name	Type	Description
`model`	`NodeDisplayModel` \| `ComboDisplayModel`	The NodeDisplayModel or ComboDisplayModel to merge the styles from.

Returns

void

Inherited from

CustomNode.mergeStyles

Defined in

packages/g6/src/stdlib/item/node/base.ts:104

onZoom

▸ onZoom(shapeMap, zoom): void

The listener for graph zooming.

show / hide some shapes while zoom level changed;
change the shapes' sizes to make them have same visual size while zooming, e.g. labelShape, labelBackgroundShape.

Parameters

Name	Type	Description
`shapeMap`	`NodeShapeMap`	The shape map that contains all of the elements to show on the node.
`zoom`	`number`	The zoom level of the graph.

Returns

void

Overrides

CustomNode.onZoom

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:209

updateCache

▸ updateCache(shapeMap): void

Call it after calling draw function to update cache about bounds and zoom levels.

Parameters

Name	Type	Description
`shapeMap`	`any`	The shape map that contains all of the elements to show on the node.

Returns

void

Inherited from

CustomNode.updateCache

Defined in

packages/g6/src/stdlib/item/node/base.ts:164

upsertShape

▸ upsertShape(type, id, style, shapeMap): DisplayObject<any, any>

Create (if does not exit in shapeMap) or update the shape according to the configurations.

Parameters

Name	Type	Description
`type`	`SHAPE_TYPE` \| `SHAPE_TYPE_3D`	shape's type
`id`	`string`	unique string to indicates the shape
`style`	`Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `interactive?`: `boolean` } & { `animates?`: `IAnimates` ; `lod?`: `number` ; `visible?`: `boolean` }>	style to be updated
`shapeMap`	`Object`	the shape map of a node / combo

Returns

DisplayObject<any, any>

The display object representing the shape.

Overrides

CustomNode.upsertShape

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:193

Properties

boundsCache

• boundsCache: Object

Type declaration

Name	Type
`keyShapeLocal?`	`AABB`
`labelShapeGeometry?`	`AABB`

Inherited from

CustomNode.boundsCache

Defined in

packages/g6/src/stdlib/item/node/base.ts:44

defaultStyles

• defaultStyles: NodeShapeStyles

Overrides

CustomNode.defaultStyles

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:20

device

• device: any

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:23

lodLevels

• Optional lodLevels: LodStrategyObj

Inherited from

CustomNode.lodLevels

Defined in

packages/g6/src/stdlib/item/node/base.ts:43

mergedStyles

• mergedStyles: NodeShapeStyles

Overrides

CustomNode.mergedStyles

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:22

setState

• setState: (name: string, value: boolean, shapeMap: { [shapeId: string]: DisplayObject; }) => void

Type declaration

▸ (name, value, shapeMap): void

Set the state for the node.

Parameters

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.

Returns

void

Inherited from

CustomNode.setState

Defined in

packages/g6/src/stdlib/item/node/base.ts:245

themeStyles

• themeStyles: NodeShapeStyles

Overrides

CustomNode.themeStyles

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:21

type

• type: string

Overrides

CustomNode.type

Defined in

packages/g6/src/stdlib/item/node/base3d.ts:19

35 KiB Raw Blame History

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Methods

afterDraw

Parameters

Returns

Inherited from

Defined in

calculateAnchorPosition

Parameters

Returns

Inherited from

Defined in

draw

Parameters

Returns

Inherited from

Defined in

drawAnchorShapes

Parameters

Returns

Overrides

Defined in

drawBadgeShapes

Parameters

Returns

Overrides

Defined in

drawHaloShape

Parameters

Returns

Overrides

Defined in

drawIconShape

Parameters

Returns

Overrides

Defined in

drawKeyShape

Parameters

Returns

Inherited from

Defined in

drawLabelBackgroundShape

Parameters

Returns

Inherited from

Defined in

drawLabelShape

Parameters

Returns

Overrides

Defined in

drawOtherShapes

Parameters

Returns

Overrides

Defined in

getMergedStyles

Parameters

Returns

Inherited from

Defined in

mergeStyles

Parameters

Returns

Inherited from

Defined in

onZoom

Parameters

Returns

Overrides

Defined in

updateCache

Parameters

35 KiB

Raw Blame History