PortModel

Import it from @grafloria/engine.

ts
Copy
class PortModel extends DiagramEntity

Properties

Methods

• constructor(config: { id?: string; type: 'input' | 'output' | 'bi'; systemType?: string; position?: PortPosition; alignment?: PortAlignment; side?: 'left' | 'right' | 'top' | 'bottom'; // NEW: Convenience parameter index?: number; // NEW: For multiple ports per side maxConnections?: number; // --- Wave 6 (all optional; unset === pre-wave-6 behaviour) ------------- group?: string; shape?: PortShapeSpec; label?: PortLabelSpec; layout?: PortLayoutSpec; fromSpot?: PortSpot; toSpot?: PortSpot; spread?: PortSpreadSpec; style?: Recor …
• get side(): 'left' | 'right' | 'top' | 'bottom' — Get the side this port is on (convenience getter) Set the side this port is on (convenience setter)
• set side(value: 'left' | 'right' | 'top' | 'bottom') — Get the side this port is on (convenience getter) Set the side this port is on (convenience setter)
• setPosition(position: PortPosition): void — Set position
• setAlignment(alignment: PortAlignment): void — Set alignment
• setOffset(offset: Point): void — Set offset
• addAllowedType(type: string): void — Add allowed type
• removeAllowedType(type: string): void — Remove allowed type
• isTypeAllowed(type: string): boolean — Check if type is allowed
• addConnection(linkId: string, role?: 'source' | 'target'): void — Add connection
• restoreConnection(linkId: string, role?: 'source' | 'target'): void — Load-time reconcile: register a connection WITHOUT the maxConnections guard or change tracking. The connection registry is derived state that is rebuilt deterministically from the diagram's links on load — a persisted graph may legitimately exceed a since-tightened maxConnections, so enforcement applies to NEW interactive connections (addConnection), never to reloading saved state.
• removeConnection(linkId: string): void — Remove connection
• canConnect(): boolean — Check if can accept more connections
• getConnectionCount(): number — Get connection count
• getFromLinkCount(): number — How many links LEAVE this port / how many ARRIVE at it.

A self-loop that both starts and ends here registers once in currentConnections (the Set dedupes) but linkRoles can only hold one role for it, so it is counted on whichever end was registered last. That is acceptable — a port that allows self-links and also caps its directional fan-out is pathological, and the TOTAL maxConnections cap still holds.

• getToLinkCount(): number
• canConnectTo(targetPort: PortModel): boolean — Check if this port (as the SOURCE) can connect to targetPort (as the TARGET). Direction matters — this is not a symmetric predicate.

Rules:

• input can connect to output or bi
• output can connect to input or bi
• bi can connect to any

isConnectableStart on the source, isConnectableEnd on the target, the per-direction fromMaxLinks/toMaxLinks caps, the allowedTypes whitelist (which was dead config — isTypeAllowed had no caller anywhere in the tree) and dataType compatibility.

NOTE: this is the PORT-LOCAL rule. Rules that need the graph (self-links, duplicate links, connection groups) live in evaluatePortConnection(), which folds this in.

• typeIdentity(): string — The name this port answers to when another port's allowedTypes whitelist is checked: its declared data type, else its systemType, else its direction.
• getAbsolutePosition(nodeBounds: BoundingBox): Point — Get absolute position relative to node
• getEdgePosition(nodeBounds: BoundingBox): Point — Get port position at node edge (for smart mode) Returns the position at the edge midpoint based on alignment
• static findNearestPort( point: Point, ports: Map<string, PortModel>, nodeBounds: BoundingBox ): PortModel | null (static) — Find nearest port on a node to a given point Used in smart mode for auto-connect to nearest port
• getDistanceFromPoint(point: Point, nodeBounds: BoundingBox): number — Calculate distance from point to this port
• resetInteractionState(): void — Reset interaction state Called when connection drag ends or is cancelled
• setRenderingConfig(config: any): void — Set port rendering configuration from template
• getRenderingConfig(): any | undefined — Get port rendering configuration
• getEffectiveVisibility( node: any, globalDefault?: 'always' | 'on-hover' | 'never' | 'hidden' ): 'always' | 'on-hover' | 'never' | 'hidden' — Get effective visibility considering port and node configuration Priority: port config > node metadata > default ('on-hover')
• serialize(): SerializedPort — Serialize to JSON
• static fromJSON(data: SerializedPort): PortModel (static) — Deserialize from JSON