Class FlowGraphConnection<BlockT, ConnectedToT>

constructor

• new FlowGraphConnection<BlockT, ConnectedToT extends IConnectable>(
      name: string,
      _connectionType: FlowGraphConnectionType,
      _ownerBlock: BlockT,
  ): FlowGraphConnection<BlockT, ConnectedToT>

  Type Parameters

  • BlockT
  • ConnectedToT extends IConnectable

  Parameters

  • name: string
  • _connectionType: FlowGraphConnectionType
  • _ownerBlock: BlockT

  Returns FlowGraphConnection<BlockT, ConnectedToT>

_ownerBlock

Optionalmetadata

name

uniqueId

connectionType

• get connectionType(): FlowGraphConnectionType

  The type of the connection

  Returns FlowGraphConnectionType

connectTo

• connectTo(point: ConnectedToT): void

  Connects two connections together.

  Parameters

  • point: ConnectedToT

    the connection to connect to.

  Returns void

deserialize

• deserialize(serializationObject: any): void

  Deserialize from a object into this

  Parameters

  • serializationObject: any

    the object to deserialize from.

  Returns void

disconnectFrom

• disconnectFrom(point: ConnectedToT, removeFromLocal?: boolean): void

  Disconnects two connections.

  Parameters

  • point: ConnectedToT

    the connection to disconnect from.

  • removeFromLocal: boolean = true

    if true, the connection will be removed from the local connection list.

  Returns void

disconnectFromAll

• disconnectFromAll(): void

  Disconnects all connected points.

  Returns void

dispose

• dispose(): void

  Disconnects this point from every connected point.

  Returns void

getClassName

• getClassName(): string

  Returns string

  class name of the connection.

isConnected

• isConnected(): boolean

  Returns if a point is connected to any other point.

  Returns boolean

  boolean indicating if the point is connected.

serialize

• serialize(serializationObject?: any): void

  Saves the connection to a JSON object.

  Parameters

  • serializationObject: any = {}

    the object to serialize to.

  Returns void