Class FlowGraphBlock

Optionalconfig

dataInputs

dataOutputs

metadata

name

uniqueId

deserialize

• deserialize(_serializationObject: ISerializedFlowGraphBlock): void

  Deserializes this block

  Parameters

  • _serializationObject: ISerializedFlowGraphBlock

    the object to deserialize from

  Returns void

getClassName

• getClassName(): string

  Gets the class name of this block

  Returns string

  the class name

getDataInput

• getDataInput(name: string): FlowGraphDataConnection<any> | undefined

  Given the name of a data input, returns the connection if it exists

  Parameters

  • name: string

    the name of the input

  Returns FlowGraphDataConnection<any> | undefined

  the connection if it exists, undefined otherwise

getDataOutput

• getDataOutput(name: string): FlowGraphDataConnection<any> | undefined

  Given the name of a data output, returns the connection if it exists

  Parameters

  • name: string

    the name of the output

  Returns FlowGraphDataConnection<any> | undefined

  the connection if it exists, undefined otherwise

registerDataInput

• registerDataInput<T>(
      name: string,
      richType: RichType<T>,
      defaultValue?: T,
  ): FlowGraphDataConnection<T>

  Registers a data input on the block.

  Type Parameters

  • T

  Parameters

  • name: string

    the name of the input

  • richType: RichType<T>

    the type of the input

  • OptionaldefaultValue: T

    optional default value of the input. If not set, the rich type's default value will be used.

  Returns FlowGraphDataConnection<T>

  the created connection

registerDataOutput

• registerDataOutput<T>(
      name: string,
      richType: RichType<T>,
      defaultValue?: T,
  ): FlowGraphDataConnection<T>

  Registers a data output on the block.

  Type Parameters

  • T

  Parameters

  • name: string

    the name of the input

  • richType: RichType<T>

    the type of the input

  • OptionaldefaultValue: T

    optional default value of the input. If not set, the rich type's default value will be used.

  Returns FlowGraphDataConnection<T>

  the created connection

serialize

• serialize(
      serializationObject?: any,
      _valueSerializeFunction?: (
          key: string,
          value: any,
          serializationObject: any,
      ) => any,
  ): void

  Serializes this block

  Parameters

  • serializationObject: any = {}

    the object to serialize to

  • _valueSerializeFunction: (key: string, value: any, serializationObject: any) => any = defaultValueSerializationFunction

    a function that serializes a specific value

  Returns void