About the Desktop API display of JavaScript documentation

Use the Desktop API display to access and learn about selected JavaScript functions and facilities contained in standard text file rules (Rule-File-Text rule type) that may be used in your own application JavaScript code.

To access the Desktop API display, select > APIs > Desktop.

For example, the standard HTML fragment rule ListViewSelectorScript includes JavaScript functions that can respond to user events on elements of the display of a list view report. To see a text description of these functions, select the ListView Scripts link in the Packages panel.

Pegasystems classifies these functions as part of the PRPC Application Programmer Interface (API), indicating that the functions are supported and designed for use within applications. (Many other HTML fragment rules contain JavaScript functions that are not part of the API and can change without notice in later PRPC releases.)

For instructions on interpreting and interacting with the display, see Help: Using the Desktop Display of JavaScript documentation. The presentation and interactions are similar to those of JavaDocs topics produced from Java source code.

About Text File rules

Tools — User Interface