Class GraphPin

constructor

• new GraphPin(): GraphPin

• Returns GraphPin

Readonly_connections

connectionType

node

pinType

type

connectionCount

• get connectionCount(): number

• The number of connections.

  Returns number

connections

• get connections(): GraphConnection[]

• The connections to or from the pin.

  Returns GraphConnection[]

id

• get id(): UUID

• The unique ID of the pin.

  Returns UUID

isConnected

• get isConnected(): boolean

• Determines if the pin is connected.

  Returns boolean

isControlFlow

• get isControlFlow(): boolean

• Determines if the pin is a control-flow pin.

  Returns boolean

isDefaultControlFlowInput

• get isDefaultControlFlowInput(): boolean

• Determines if the pin is an input "Control-flow pin".

  Returns boolean

isDefaultControlFlowOutput

• get isDefaultControlFlowOutput(): boolean

• Determines if the pin is an output "Control-flow pin".

  Returns boolean

isInput

• get isInput(): boolean

• Determines if this is an input pin.

  Returns boolean

isOutput

• get isOutput(): boolean

• Determines if this is an output pin.

  Returns boolean

name

• get name(): string

• The pin name.

  Returns string
• set name(value): void

• Parameters

  • value: string

  Returns void

userData

• get userData(): Map<string, any>

• A map suitable for storing custom user-defined data.

  Returns Map<string, any>

clone

• clone(): GraphPin

• Clones this instance.

  Returns GraphPin

disconnect

• disconnect(): void

• Removes all connections.

  Returns void

enable

• enable(node): void

• Enables the pin for the specified node.

  Parameters

  • node: ImmutableGraphNode

  Returns void

findConnection

• findConnection(pin): GraphConnection

• Find a GraphConnection to the given pin if one exists.

  Parameters

  • pin: GraphPin

  Returns GraphConnection

getConnectedValueOrDefault

• getConnectedValueOrDefault<T>(type, executionState, defaultValue): ValueTypeOf<T>

• Retrieves the value of this pin.

  Type Parameters

  • T

  Parameters

  • type: GraphType | ClassOf<T>
  • executionState: GraphExecutionState
  • defaultValue: ValueTypeOf<T>

  Returns ValueTypeOf<T>

  Note

  Input pins will forward the request to the connected pin, if connected. Output pins will request the value from the respective node.

  If the input pin is not connected, the defaultValue will be used. If a default value is not specified, the internal field storage will be used.

  Output pins must return a valid, undefined value, otherwise a warning message is logged.

isConnectable

• isConnectable(otherPin, validatePortCapacity): boolean

• Determines if this pin is connectable to the otherPin

  Parameters

  • otherPin: GraphPin
  • validatePortCapacity: boolean

  Returns boolean

markAsDirty

• markAsDirty(flags): void

• Method that must be called whenever the GraphPin is dirtied.

  Parameters

  • flags: EnumValue<GraphNodeDirtyFlags, number>

  Returns void

onClone

• onClone(): void

• Internal callback method called after cloning the owning Node.

  Returns void

toString

• toString(): string

• Returns a string representation of an object.

  Returns string

validate

• validate(validationStatus): GraphValidationStatus
• Virtual

  Ensures that the state of the pin is valid.

  Parameters

  • validationStatus: Map<GraphObject, string>

  Returns GraphValidationStatus

  Note

  Implementing classes must call super. The method is typically called after deserialization or major edits to the graph. If validation fails, error information must be added to the validationStatus map.

ReadonlyonDirty