Cells
Category | Name | Matching Order | Matching Rule | Description | More info |
---|---|---|---|---|---|
- | BaseCell | n/o | n/o | All Cell`s definition classes extend it. | abstract |
Content | NormalCell | 1 | not started by ## , #! or #= | This one copy all styles, width, properties and value form template. | default |
Content | VariableCell | 3 | ## pathToVariable | Write variable from ViewModel . Paths to object's property or array item are allowed. When asking about undefined variable it returns empty string. | Paths examples: simplePath someObject.property array.0.field items.1.path.to.object.prop |
Content | TemplateStringCell | 4 | Starts with #` | Template string allows you to create advanced text, for example concat two variables or put them into a sentence. To write in a variable use ${pathToVariable} . | Example:#` Hello ${name}! How are you? gives for instance Hello World! How are you? Example |
Content | HyperlinkCell | 7 | #! HYPERLINK pathToLabel pathToTarget | Create a hyperlink. | Paths resolve exactly same as VariableCell |
Content | FormulaCell | 6 | Cell.type eq. formulae | It handles correctly formulas inside and outside of loops - when rows were shifted compared to the template. | It is used automatically when formulae from the template being rendered Example |
Content | TemplateFormulaCell | 5 | Starts with #= | This one allows you to put a template string (custom formula) into a cell as a formula. To write in a variable use ${pathToVariable} . | Example:#= ${summaryFormula}(A2:A${item.__endOutput.r}) gives something like =MAX(A2:A2910) Example |
Navigation | EndRowCell | 2 | #! END_ROW | Go to the beginning of next row | |
Worksheet Navigation Loop | FinishCell | 9 | #! FINISH conditionPath | Finish rendering for current worksheet and: 1) go to next worksheet if conditionPath===true 2) repeat this template worksheet again ( conditionPath === false ) - looping through worksheets 3) finished whole rendering when this worksheet is the last one. | Examples:#! FINISHED or #! FINISHED itemFromLoop.__iterated |
Worksheet | WsNameCell | 15 | #! WS_NAME pathToVariable | Set worksheet's name. | Examples: #! WS_NAME worksheetName #! WS_NAME item.title #! WS_NAME translatedNames.0 |
Loop | DumpColsCell | 12 | #! DUMP_COLS pathToArray | Useful for writing through multiple columns. It put each value of array to next column. | Example |
Loop | ForEachCell | 8 | #! FOR_EACH item items | Begin the loop named item , set the first element of items into item and go to the beginning of next line. | Connected to: ContinueCell , EndLoopCell , DeleteCell , FinishedCell , SumCell , AverageCell . |
Loop | ContinueCell | 11 | #! CONTINUE item | Iterate to next element of loop named item (check ForEachCell for more information) and navigate to the beginning of new line. | |
Loop | EndLoopCell | 10 | #! END_LOOP item | Mark cell when the loop item finished. | |
Aggregation | SumCell | 13 | #! SUM item | Write sum formulae for current column and the item 's rows. | Example |
Aggregation | AverageCell | 14 | #! AVERAGE item | Write average formulae for current column and the item 's rows. | Example |
View Model | DeleteCell | 16 | #! DELETE pathToVariable | Delete variable, useful for nested loops. | Example |