Input Parameter allows you to create custom fields that can change the flow result. These fields display in the Properties palette.
The input parameter can be configured to many different types of data, and makes it possible to expose variables from a flow for easier modification.
Outputs
Name | Abbreviation | Type | Access | Description |
Value | V | Any | Item | The value of the input |
How to
Enter a name
The Name field is how the parameter will appear in the Properties palette. Give it a descriptive name
Enter a description
The description is a tooltip text for the property. Give your end-user some more instructions on how to use this node.
Size
Choose single or list.
Single allows one unique input value
List adds a UI to manage a list of items.
Type
The Type determines the input’s format. This is important for nodes that require specific data types.
String - a simple text box
Number - a number spinner, precision, optional min and max, and distance type.
Precision: The number of decimal places
Min - the lowest allowed value in the spinner
The highest allowed value in the spinner
Dimension - select dimensionless, or metric/imperial units
Vector - x, y, z coordinates
Color - A color selector
Boolean - a toggle
Feature - select or create a geometry of the project to use as in input
Useful for geometric operations like boolean difference or creating complex geometries with Generative nodes like Apartment. Select the allowed feature types - Point, polyline, or enclosed polygon. By default, all shape types are allowed. Click a type to unselect.
The feature parameter displays in the Properties UI as a list manager. Click "manage {{parameter name}} to add geometries to the flow.
The Feature list
Move feature up/down
Duplicate
Remove (removes from the flow, but does not delete the feature from the project)
Pick - pick an existing feature from the map to add to the input list
Draw - draw a new feature. Select from the allowed types.
Clear - Remove all features from the list (removes from the flow, but does not delete the feature from the project)
Select All - Select all of the features to move/adjust
Group - select groups to use as flow inputs
In the property palette, type a group name, or click pick to select a group from the map.
Default Value
If you input a default value, the flow will inherit that setting on every new geometry it’s added to. Otherwise, the default will be empty or 0.
Example:
Set the property value of a geometry via a flow.
