Class Port<Value, PortMetadata>

constructor

• new Port<Value = any, PortMetadata = any>(
      options: AddPortOptions<Value, PortMetadata>,
      node: Node<PortMetadata>,
  ): Port<Value, PortMetadata>

• Type Parameters

  • Value = any
  • PortMetadata = any

  Parameters

  • options: AddPortOptions<Value, PortMetadata>
  • node: Node<PortMetadata>

  Returns Port<Value, PortMetadata>

Readonly$connectedTo

Readonly$customDisplayName

Readonly$direction

Readonly$isDisconnecting

Readonly$isPulsing

Readonly$lastChangeTime

Readonly$metadata

Readonly$validity

Readonly$value

Readonly$x

Readonly$y

Optional ReadonlycustomValueType

Readonlyflow

Readonlynode

ReadonlysuperType

Readonlyvalidate

connectedTo

• get connectedTo(): Port[]

• Returns Port[]

customDisplayName

• get customDisplayName(): null | string

• Returns null | string

direction

• get direction(): PortDirection

• Returns PortDirection

displayName

• get displayName(): string

• Returns string

id

• get id(): string

• Returns string

isDisconnecting

• get isDisconnecting(): boolean

• Returns boolean

isPulsing

• get isPulsing(): boolean

• Returns boolean

lastChangeTime

• get lastChangeTime(): number

• Returns number

metadata

• get metadata(): PortMetadata

• Returns PortMetadata

name

• get name(): string

• Returns string

validity

• get validity(): boolean

• Returns boolean

value

• get value(): null | Value

• Returns null | Value

x

• get x(): number

• Returns number

y

• get y(): number

• Returns number

bang

• bang(): void

• Returns void

connectTo

• connectTo(id: string): void

• Parameters

  • id: string

  Returns void

disconnect

• disconnect(id: string): void

• Parameters

  • id: string

  Returns void

disconnectAll

• disconnectAll(): void

• Returns void

fromJSON

• fromJSON(options: AddPortOptions<Value, PortMetadata>): void

• Parameters

  • options: AddPortOptions<Value, PortMetadata>

  Returns void

setIsDisconnecting

• setIsDisconnecting(value: boolean): void

• Parameters

  • value: boolean

  Returns void

setIsPulsing

• setIsPulsing(state: boolean): void

• Parameters

  • state: boolean

  Returns void

setValidity

• setValidity(state: boolean): void

• Parameters

  • state: boolean

  Returns void

toJSON

• toJSON(): {
      connectedTo: { node: string; port: string }[];
      value: null | Value;
      x: number;
      y: number;
  }

• Returns {
      connectedTo: { node: string; port: string }[];
      value: null | Value;
      x: number;
      y: number;
  }

updateDisplayName

• updateDisplayName(customName: string): void

• Parameters

  • customName: string

  Returns void

updatePositionFromDom

• updatePositionFromDom(
      __namedParameters: {
          cableOffset?: number;
          rect: DOMRect;
          scroll: { x: number; y: number };
      },
  ): void

• Parameters

  • __namedParameters: { cableOffset?: number; rect: DOMRect; scroll: { x: number; y: number } }

  Returns void

updateValue

• updateValue(value: null | Value): void

• Parameters

  • value: null | Value

  Returns void