showPage(pageName, className, options)
Displays the page of a class.
Returns
A Promise associated with the action.
Parameters
Name | Type | Description | Required |
pageName | string | The name of the page to be
displayed. Example:
| ✅ |
className | string | The name of the class to which the page
belongs. Example:
| ✅ |
options | object | The JavaScript object containing the properties to display the page. | ❌ |
The following table contains the properties of the options object:
Name | Type | Description | Required |
containerName | string | The name of the container that displays the page. | ❌ |
skipSemanticUrl | string | The flag that determines if the semantic URL evaluation logic must be skipped. | ❌ |
Usage example
In this example, the API obtains and displays the view metadata and class name of a page.
const showPagePromise = getPConnect().getActionsApi().showPage("pyHome", "Data-Portal");
showPagePromise.then(() => {
// show page success handling
}).catch(() => {
// show page failure handling
});
Previous topic showDataPreview(dataContext, dataContextParameters, options) Next topic triggerFieldChange(propName, value)