Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

showPage(pageName, className, options)

Updated on July 20, 2021

Displays the page of a class.


A Promise associated with the action.


pageNamestringThe name of the page to be displayed.


pageName = "pyHome"
classNamestringThe name of the class to which the page belongs.


className: "Data-Portal"
optionsobjectThe JavaScript object containing the properties to display the page.

The following table contains the properties of the options object:

containerNamestringThe name of the container that displays the page.
skipSemanticUrlstringThe flag that determines if the semantic URL evaluation logic must be skipped.
Note: The default value is false.
  • If the value is false, the semantic URL evaluation logic will not be skipped.
  • If the value is true, the semantic URL evaluation logic will 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)

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us