Instructs the Toolkit to add a new port with the given data to the vertex this component represents.
Parameters
type: string
data: ObjectData
Returns void
cloneGroup
cloneGroup(options?): void
Clones this group
Parameters
Optionaloptions: VertexCloneOptions
Returns void
cloneVertex
cloneVertex(options?): void
Clones this vertex, optionally setting to a given position, or offsetting from the original, and optionally magnetizing
the new vertex's position, and flashing it to show the user where it is.
Parameters
Optionaloptions: VertexCloneOptions
Returns void
getGroup
getGroup(): Group
Gets the node that this component represents.
Returns Group
getVertex
getVertex(): Group
Gets the vertex that this component represents.
Returns Group
removeGroup
removeGroup(): void
Shortcut method to remove the Group (and therefore this whole component)
Returns void
removeVertex
removeVertex(): void
Removes the vertex this component represents from the data model, which will cause this component to be cleaned up.
Returns void
updateGroup
updateGroup(data): void
Shortcut method to update the current data backing this Group, for convenience.
Parameters
data: ObjectData
Returns void
updateVertex
updateVertex(data): void
Shortcut method to update the current data backing this vertex, for convenience.
Parameters
data: ObjectData
Returns void
Properties
obj
obj:ObjectData
Data object for the vertex
ReadonlyobjSignal
objSignal:WritableSignal<ObjectData> = ...
This signal represents the underlying data for the vertex this component represents.
The base class for components that will be rendered as Groups. Your Group components should extend this class.