system.vision.exportExcel

Backwards Compatibility

This function replaces system.dataset.exportExcel. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.

This function is used in Python Scripting.

Description

Exports the contents of a dataset as an Excel spreadsheet, prompting the user to save the file to disk. To write silently to a file, you cannot use the vision.export* functions. Instead, use the system.dataset.toExcel function.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.exportExcel(filename, showHeaders, dataset, [nullsEmpty])

Parameters

Type	Parameter	Description
String	filename	A suggested filename to save as.
Boolean	showHeaders	If true, the spreadsheet will include a header row.
Dataset \ List[Dataset]	dataset	Either a single dataset, or a list of datasets. When passing a list, each element represents a single sheet in the resulting workbook.
Boolean	nullsEmpty	If True, the spreadsheet will leave cells with NULL values empty, instead of allowing Excel to provide a default value like 0. Defaults to False. [optional]

Returns

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

Scope

Vision Client

Code Examples

Code Snippet

# This snippet prompts the user to save the data currently displayed in a Table component 
# to an Excel-compatible spreadsheet file. It opens the file after a successful save.
  
table = event.source.parent.getComponent("Table")
filePath = system.vision.exportExcel("data.xlsx", 1, table.data)
if filePath != None:
   system.net.openURL("file://"+filePath)