g6/packages/site/docs/apis/item/WIP-SphereNode.zh.md

title
SphereNode

📋 中文文档还在翻译中... 欢迎 PR

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

item.SphereNode

Hierarchy

• CustomNode3D

  ↳ SphereNode

Constructors

constructor

• new SphereNode(props)

Parameters

Name	Type
props	any

Overrides

CustomNode3D.constructor

Defined in

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

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

CustomNode3D.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

CustomNode3D.calculateAnchorPosition

Defined in

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

---

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

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

NodeShapeMap

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

Overrides

CustomNode3D.draw

Defined in

packages/g6/src/stdlib/item/node/sphere.ts:26

---

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

Inherited from

CustomNode3D.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.

Inherited from

CustomNode3D.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.

Inherited from

CustomNode3D.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.

Inherited from

CustomNode3D.drawIconShape

Defined in

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

---

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

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 key shape of the node.

Overrides

CustomNode3D.drawKeyShape

Defined in

packages/g6/src/stdlib/item/node/sphere.ts:86

---

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

CustomNode3D.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.

Inherited from

CustomNode3D.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.

Inherited from

CustomNode3D.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

CustomNode3D.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

CustomNode3D.mergeStyles

Defined in

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

---

onZoom

▸ onZoom(shapeMap, zoom): void

The listener for graph zooming.

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

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

Inherited from

CustomNode3D.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

CustomNode3D.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.

Inherited from

CustomNode3D.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

CustomNode3D.boundsCache

Defined in

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

---

defaultStyles

• defaultStyles: Object

Type declaration

Name	Type
keyShape	{ latitudeBands: number = 32; longitudeBands: number = 32; r: number = 5; x: number = 0; y: number = 0; z: number = 0 }
keyShape.latitudeBands	number
keyShape.longitudeBands	number
keyShape.r	number
keyShape.x	number
keyShape.y	number
keyShape.z	number

Overrides

CustomNode3D.defaultStyles

Defined in

packages/g6/src/stdlib/item/node/sphere.ts:12

---

device

• device: any

Inherited from

CustomNode3D.device

Defined in

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

---

lodLevels

• Optional lodLevels: LodStrategyObj

Inherited from

CustomNode3D.lodLevels

Defined in

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

---

mergedStyles

• mergedStyles: NodeShapeStyles

Overrides

CustomNode3D.mergedStyles

Defined in

packages/g6/src/stdlib/item/node/sphere.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

CustomNode3D.setState

Defined in

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

---

themeStyles

• themeStyles: NodeShapeStyles

Inherited from

CustomNode3D.themeStyles

Defined in

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

---

type

• type: string

Inherited from

CustomNode3D.type

Defined in

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