Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed an example...that didn't actually use the function on this page...


Exports the contents of a dataset as a CSV file, prompting the user to save the file to disk.


system.dataset.exportCSV(filename, showHeaders, dataset)

  • Parameters

String filename - A suggested filename to save as.

boolean showHeaders - If true (1), the CSV file will include a header row.

Dataset dataset - The dataset to export.

  • Returns

String - The path to the saved file, or None if the action was canceled by the user.

  • Scope


titleCode Examples

Code Block
titleCode Snippet
#This snippet would prompt the user to save the data currently displayed in a Table component to a CSV file, and would open the file (in an external program, presumably Excel) after a successful save.
table = event.source.parent.getComponent("Table")
filePath = system.dataset.exportCSV("data.csv", 1,
if filePath != None:"file:///"+filePath.replace('\\','/'))


To write silently to a file, you cannot use the dataset.export* functions. Instead, use the toCSV() function as below:

Code Block
titleCode Snippet
### This script DOES NOT USE the system.dataset.exportCSV() function ###
# take data and silently write it in CSV format to a file
# this script would be on a button with a from a table in the same container 

# get data
data = event.source.parent.getComponent('Table').data
# convert to csv 
CSVdata = system.dataset.toCSV(data)
# write file
system.file.writeFile("C:\\temp\\data.csv", CSVdata)