Back Forward About the Desktop API display of JavaScript documentation

zzzUse 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 Help > 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 Process Commander 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 Process Commander 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.

TipWhen debugging JavaScript code, select Edit > Preferences and check the Disable compacting check box in the JavaScript section of the General preferences panel. When not checked, this preference causes variable names to be scrambled before the JavaScript is sent to a browser, and removes spaces and comments from the JavaScript source code, making this code less easy to read and understand. Clear the check box when finished debugging, for best performance.

Related topics About Text File rules

zzz Tools, accelerators, and wizards