system.vision.exportHTML

Backwards Compatibility

This function replaces system.dataset.exportHTML. 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 to an HTML page. Prompts the user to save the file to disk.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.exportHTML(filename, showHeaders, dataset, title)

Parameters

Type	Parameter	Description
String	filename	A suggested filename to save as.
Boolean	showHeaders	If true, the HTML table will include a header row.
Dataset / PyDataset	dataset	The dataset to export.
String	title	The title for the HTML page.

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 - Export then Open

# This snippet prompts the user to save the data currently displayed in a Vision Table component to an HTML 
# file, and opens the file in the default web  browser after a successful save.
  
table = event.source.parent.getComponent("Table")
filePath = system.vision.exportHTML("data.html", 1, table.data, "Production Report")
if filePath != None:
   system.vision.openURL("file://"+filePath)