You're currently browsing the Ignition 7.8 docs. Click here to view the latest docs.

Description

Gets a data of all reports for a project. This dataset is particularly suited for display in a Tree View component

Syntax

Since 7.8.1

This function accepts keyword arguments.

system.report.getReportNamesAsDataset(project)

  • Parameters

String project - The name of the project where the reports are located. Optional in client scope.

  • Returns

List - A dataset of report paths and names for the project. Returns an empty dataset if the project has no reports.

  • Throws

IllegalArgumentException - Thrown when any of the following occurs: If the project name is omitted in the Gateway scope, project does not exist.

  • Scope

All

Code Examples
Code Snippet
# Gets a dataset of reports for the current project and displays
# them in a Tree View component.

event.source.parent.getComponent('Tree View').data = system.report.getReportNamesAsDataset()