-
Notifications
You must be signed in to change notification settings - Fork 5
Connector Mesh
anidivr edited this page Nov 29, 2023
·
2 revisions
ConnectorMesh
extends Mesh
and represents the shape for a connector anchored to a node. Connectors are attachment points for edges on nodes. Its an internal class used by FlowConnector
and not meant to be used or extended directly.
-
ConnectorMesh(node: NodeConnectors, parameters: FlowConnectorParameters)
-
Description: Constructs a new
ConnectorMesh
instance associated with a specific node and configured using the provided parameters. -
Parameters:
-
node
(NodeConnectors): The NodeConnectors instance managing this connector. -
parameters
(FlowConnectorParameters): Configuration parameters for the connector.
-
-
Example:
const nodeConnectors = flowConnectors.hasNode('node1'); const connectorMesh = new ConnectorMesh(nodeConnectors, { id: 'connector1', anchor: 'left' });
-
Description: Constructs a new
-
index
-
Type:
number
- Description: When multiple connectors are at the same location, use index to place in a specific order
-
Type:
-
anchor
-
Type:
AnchorType
- Description: The anchor position of the connector on the node.
-
Type:
-
color
-
Type:
ColorRepresentation
- Description: The color of the connector.
-
Type:
-
label
-
Type:
FlowLabel | undefined
- Description: An optional label associated with the connector.
-
Type:
-
labeloffset
-
Type:
number
- Description: The offset distance for the label from the connector.
-
Type:
-
transform
-
Type:
FlowTransform | undefined
- Description: Transformation adjustments for position and rotation.
-
Type:
-
shape
-
Type:
string
- Description: The shape of the connector.
-
Type:
-
hidden
-
Type:
boolean
- Description: Determines whether the connector is hidden.
-
Type:
-
width
-
Type:
number
- Description: The width of the connector.
-
Type:
-
height
-
Type:
number
- Description: The height of the connector.
-
Type:
-
radius
-
Type:
number
- Description: The radius of the connector, used when the shape is circular.
-
Type:
-
isFlow
-
Type:
boolean
- Description: A flag indicating that this mesh is part of the flow diagram system.
-
Type: