system.dataset.addRow
This function is used in Python Scripting.
Description
Takes a dataset and returns a new dataset with a new row added or inserted into it. Datasets are immutable, so it is important to realize that this function does not actually add a row to a dataset. You'll need to do something with the new dataset that this function creates to achieve something useful. If the rowIndex argument is omitted, the row will be appended to the end of the dataset.
Client Permission Restrictions
This scripting function has no Client Permission restrictions.
Syntax
system.dataset.addRow(dataset [, rowIndex], row)
Parameters
| Type | Parameter | Description |
|---|---|---|
| Dataset | dataset | The starting dataset. Please be aware that this dataset will not actually be modified (datasets are immutable), but rather will be the starting point for creating a new dataset. |
| int | rowIndex | The index (starting at 0) at which to insert the new row. Will throw an IndexError if less than zero or greater than the length of the dataset. If omitted, the new row will be appended to the end. [optional] |
| PySequence | row | A Python sequence representing the data for the new row. Its length must equal the number of columns in the dataset. |
Returns
Dataset - A new dataset with the new row inserted or appended.
Scope
All
Code Examples
Example 1
# This example would add a new option to a Dropdown List by adding a row to its underlying dataset. Notice how the last line assigns the return value of the addRow function to the dropdown's data property.
dropdown = event.source.parent.getComponent("Dropdown")
newRow = [5, "New Option"]
dropdown.data = system.dataset.addRow(dropdown.data, newRow)
Example 2
# This snippet would add a new option into a Dropdown component just like above, but at the beginning:
dropdown = event.source.parent.getComponent("Dropdown")
newRow = [5, "New Option"]
dropdown.data = system.dataset.addRow(dropdown.data, 0, newRow)