Skip to end of metadata
Go to start of metadata

This feature is new in Ignition version 7.9.7
Click here to check out the other new features
This function is used in Python Scripting.

Description

Takes a dataset and returns a new dataset with new rows added or inserted into it. Datasets are immutable, so it is important to realize that this function does not actually add rows 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 rows will be appended to the end of the dataset.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.dataset.addRows(dataset [, rowIndex], rows)

  • Parameters

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 rows - A Python sequence of sequences representing the data for the new rows. The length of each sequence must equal the number of columns in the dataset.

  • Returns

Dataset - A new dataset with the new rows inserted or appended.

  • Scope

All

Code Examples
Code Snippet
# This example would add new options to a Dropdown List by adding a row to its underlying dataset. 
# Note that the last line assigns the return value of the addRows function to the dropdown's data property.

dropdown = event.source.parent.getComponent("Dropdown")
newRow = [[5, "New Option"], [6, "Another New Option"]]
dropdown.data = system.dataset.addRows(dropdown.data, newRow)
Code Snippet
# This snippet would add new options into a Dropdown component just like above, but at the beginning:

dropdown = event.source.parent.getComponent("Dropdown")
newRow = [[5, "New Option"], [6, "Another New Option"]]
dropdown.data = system.dataset.addRows(dropdown.data, 0, newRow) 
  • No labels