Row Template Variables
Row variables represent each row in a dataset.
Standard Row Variables
| Variable | Description |
|---|---|
| row.name | The value of the name column in the row. |
| row.quantity | The value of the quantity column in the row. Defaults to 1 if not set. |
| row.column | The calculated value of any particular column that you create in the dataset. All columns are accessible at the root level. |
Note: column above is not the name of an actual column, but rather a placeholder representing any columns you create in your dataset. For example, if you have a column called "color", you would access it as row.color.
Index Variables
| Variable | Description |
|---|---|
| row.$index | The position of this row in the dataset (0-based). This is the row number, not the enumeration number. |
| row.$enumerationIndex | The position of this specific enumeration within the current row's enumerations (0-based). If a row generates 3 enumerations, this will be 0, 1, or 2. |
| row.$globalIndex | The position of this enumeration across all enumerations in the entire dataset (0-based). This counts enumerations from all rows sequentially. |
Identification Variables
| Variable | Description |
|---|---|
| row.$rowId | The unique identifier for this row in the dataset. |
| row.$enumerationName | The generated name for this enumeration. Consists of the row name followed by the enumeration values, joined with ' - '. For example: "Card - Red - Large". |
Understanding Indexes
The three index variables serve different purposes:
- $index - Identifies which row in your dataset this enumeration came from. Multiple enumerations from the same row will have the same $index.
- $enumerationIndex - Identifies which enumeration this is within its parent row. Useful for determining "this is the 1st of 4 variations of this card."
- $globalIndex - Provides a unique sequential number for each enumeration across your entire dataset. Useful for numbering all cards sequentially regardless of which row they came from.