format string
The format string module allows you to construct a complex string (for use in titles or as file names) using multiple string and numeric inputs. An expression determines the content of the output. The expression is treated as a Python f-string which allows for the use of variables with Python expressions and format specifiers.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Z Scale | Number | The factor for vertical scaling. |
| Input | Explode | Number | The value used for separating output based on geology. |
| Input | Number 1 | Number | A value to use as a variable. |
| Input | Number 2 | Number | A value to use as a variable. |
| Input | Number 3 | Number | A value to use as a variable. |
| Input | Number 4 | Number | A value to use as a variable. |
| Input | Number 5 | Number | A value to use as a variable. |
| Input | Number 6 | Number | A value to use as a variable. |
| Input | String 1 | String | A string to use as a variable. |
| Input | String 2 | String | A string to use as a variable. |
| Input | String 3 | String | A string to use as a variable. |
| Input | String 4 | String | A string to use as a variable. |
| Input | Date | Date | The date to use as an input. |
| Output | Result String | String | A string created by solving the module expression. |
Properties
| Property | Type | Description |
|---|---|---|
| Expression | Expression | The Expression allows the user to control the sequence of variables used to create the output string. Supports variables: {Scale}, {Explode}, {N1} through {N6}, {S1} through {S4}, and {Date}. |
| Date Format | String | The Date Format allows the user to control how Date values will be displayed in the output string. |
Variables
| Property | Type | Description |
|---|---|---|
| Scale | Double | Scale is the scaling factor for vertical (z) coordinates. This value reflects a multiplication factor of the layer thickness. |
| Explode | Double | The Explode value is the distance between exploded layers, cell sets or materials. |
| N1 | Double | The N1 field is a double value that can be used as the variable {N1} in the expression. |
| N2 | Double | The N2 field is a double value that can be used as the variable {N2} in the expression. |
| N3 | Double | The N3 field is a double value that can be used as the variable {N3} in the expression. |
| N4 | Double | The N4 field is a double value that can be used as the variable {N4} in the expression. |
| N5 | Double | The N5 field is a double value that can be used as the variable {N5} in the expression. |
| N6 | Double | The N6 field is a double value that can be used as the variable {N6} in the expression. |
| S1 | String | The S1 field is a string value that can be used as the variable {S1} in the expression. |
| S2 | String | The S2 field is a string value that can be used as the variable {S2} in the expression. |
| S3 | String | The S3 field is a string value that can be used as the variable {S3} in the expression. |
| S4 | String | The S4 field is a string value that can be used as the variable {S4} in the expression. |
| Date | Date | The Date field is a date value that can be used as the variable {Date} in the expression. |
Output
| Property | Type | Description |
|---|---|---|
| Result | String | The Result is the output string created by resolving the Expression. This field is read-only. |