PortModel

Import it from @grafloria/engine.

Also has every member of DiagramEntity, listed on its own entry.

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'; index?: number; maxConnections?: number; group?: string; shape?: PortShapeSpec; label?: PortLabelSpec; layout?: PortLayoutSpec; fromSpot?: PortSpot; toSpot?: PortSpot; spread?: PortSpreadSpec; style?: Record<string, any>; visible?: boolean; dataType?: string; isConnectableStart?: boolean; isConnectableEnd?: boolean; fromMaxLinks?: number | null; toMaxLinks?: number | null; allowSelfLink?: boolean; allowDuplicateLinks?: boolean; allowedTypes?: string[]; dynamic?: boolean; })
• 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.
• 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.
• 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