system.dataset.toPyDataSet

note

This function was removed from Ignition in version 8.3 since datasets no longer need to be manually wrapped as PyDatasets. Instead, any scripting with datasets automatically exposes them as if they were PyDatasets.

This function is used in Python Scripting.

Description

This function converts from a normal dataset to a PyDataset, which is a wrapper class which makes working with datasets more Python-esque. For more information on datasets and PyDatasets, see the Datasets page.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.dataset.toPyDataSet(dataset)

Parameters

Type	Parameter	Description
Dataset	dataset	A dataset object to convert into a PyDataset.

Returns

PyDataset - The newly created PyDataset.

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Code Snippet - Summing Values in a Column

# This example script would be added to a button that is in the same container as the table you are working with. 
# It grabs the data of the Table component, and adds up the values in the first column, displaying the result to the user.
  
# Get a Table component's data.
table = event.source.parent.getComponent("Table")
data = system.dataset.toPyDataSet(table.data)
  
# Loop through the data, summing the Value column.
value = 0.0
for row in data:
   value += row[0]
  
# Show the user the sum of the Value column.
system.gui.messageBox("The value is: %f" % value)