Public JavaScript APIs
Public JavaScript APIs provide you with tools to integrate custom controls into Pega Platform.
Creating non-auto generated controls requires markup that contains specific attributes to represent events and actions. When these attributes are used, Pega Platform routes actions and events through the same infrastructure as the auto-generated controls.
The APIs are available in the pega.api.ui.actions and pega.api.ui.actions.list namespaces. All APIs must be invoked with complete namespace, for example: pega.api.ui.actions.refreshSection(params).
Discover more about Pega-supported public JavaScript APIs in the following articles:
- addListItem
Adds a new item to a table or a repeating dynamic layout.
- editListItem
Enables editing of the active row in a table, hierarchical list, hierarchical table, or repeating dynamic layout.
- getDataPage
Retrieves data page information from the clipboard in JSON format.
- launchHarness
Launches a harness. You can configure this API to replace the current harness, open a new harness, or launch the harness in a pop-up window.
- launchLocalAction
Launches a local action as a modal dialog, an overlay, or by replacing the current section.
- openLocalAction
Launches a local action in a modal dialog box in the context of a list item.
- openURLInWindow
Opens an external or internal URL in a browser window. The URL can be accessed through an activity or a data transform.
- refreshHarness
Refreshes the current harness.
- refreshSection
Refreshes a section. When refreshing a target section, the system refreshes all sections that share the name of the target section.
- runActivity
Runs an activity from a script.
- setValues
Sets the value of a target property from a source property or a literal constant. Supports setting multiple target properties through a single call.
Previous topic Creating binary file rules Next topic addListItem