Class FlowGraphConditionalDataBlock<T>
Type Parameters
- T
Hierarchy (View Summary)
- FlowGraphBlock
- FlowGraphConditionalDataBlock
Constructors
constructor
-
new FlowGraphConditionalDataBlock<T>(
config?: IFlowGraphBlockConfiguration,
): FlowGraphConditionalDataBlock<T>Creates a new instance of the block
Type Parameters
- T
Parameters
Optionalconfig: IFlowGraphBlockConfigurationoptional configuration for this block
Returns FlowGraphConditionalDataBlock<T>
Properties
Readonlycondition
Input connection: The condition to check.
Optionalconfig
the configuration of the block
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.
Readonlyon
Input connection: The value to return if the condition is false.
Readonlyon
Input connection: The value to return if the condition is true.
Readonlyoutput
Output connection: The value that was returned.
unique
A randomly generated GUID for each block.
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
-
serialize(
serializationObject?: any,
_valueSerializeFunction?: (
key: string,
value: any,
serializationObject: any,
) => any,
): voidSerializes 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
- serializationObject: any = {}
Block that returns a value based on a condition.