showDataPreview(dataContext, dataContextParameters, options)
Displays a preview of a data item in the preview panel.
Returns
A promise associated with the action.
Parameters
Name | Type | Description | Required |
dataContext | string | The name of the data page whose data must be displayed. | ✅ |
dataContextParameters | string | The parameters associated with the data page. | ✅ |
options | object | The JavaScript object containing the properties to display the data. | ❌ |
Usage example
In this example, the API displays the preview of a data item (identified by
dataContext
and the dataContextParameters
)
inside the preview panel with the extra configuration object provided.
getPConnect().getActionsApi().showDataPreview(dataContext, dataContextParameters, options);
Previous topic showData(pageName, dataContext, dataContextParameters, options) Next topic showPage(pageName, className, options)