Class FlowGraphGetVariableBlock<T>
Type Parameters
- T
Hierarchy (View Summary)
- FlowGraphBlock
- FlowGraphGetVariableBlock
Constructors
constructor
-
new FlowGraphGetVariableBlock<T>(
config: IFlowGraphGetVariableBlockConfiguration<T>,
): FlowGraphGetVariableBlock<T>Construct a FlowGraphGetVariableBlock.
Type Parameters
- T
Parameters
- config: IFlowGraphGetVariableBlockConfiguration<T>
construction parameters
Returns FlowGraphGetVariableBlock<T>
Properties
config
construction parameters
data
The data inputs of the block.
data
The data outputs of the block.
metadata
Metadata that can be used by the block.
name
The name of the block.
unique
A randomly generated GUID for each block.
Readonlyvalue
Output connection: The value of the variable.
Methods
deserialize
-
Deserializes this block
Parameters
- _serializationObject: ISerializedFlowGraphBlock
the object to deserialize from
Returns void
- _serializationObject: ISerializedFlowGraphBlock
get
-
Gets the class name of this block
Returns string
the class name
get
-
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
- name: string
get
-
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
- name: string
register
-
registerDataInput<T>(
name: string,
richType: RichType<T>,
defaultValue?: T,
): FlowGraphDataConnection<T>Registers a data input on the block.
Type Parameters
- T
Parameters
Returns FlowGraphDataConnection<T>
the created connection
register
-
registerDataOutput<T>(
name: string,
richType: RichType<T>,
defaultValue?: T,
): FlowGraphDataConnection<T>Registers a data output on the block.
Type Parameters
- T
Parameters
Returns FlowGraphDataConnection<T>
the created connection
serialize
-
Serializes this block
Parameters
OptionalserializationObject: anythe object to serialize to
Returns void
A block that gets the value of a variable. Variables are an stored in the context of the flow graph.