launchLocalAction
Launches a local action as a modal dialog, an overlay, or by replacing the current section.
Signature
launchLocalAction(options)
Returns
Not applicable.
Parameters
| Name | Description | Type | Required |
| flowAction | Specifies the name of the flow action that the API launches. | String | ✅ |
| displayMode | Specifies the target location for the local action. The following
values are available:
| Constant | ❌ |
| event | Specifies the event that launches the window. | DOM event object | ✅ |
| flowActionClass | Specifies the name of the class to which the flow action belongs. | String | ✅ |
| contextPage | Specifies the name of the context page for the flow action. | String | ❌ |
| skinFormat | Specifies the skin format for the overlay or the modal dialog box. The
default value is Standard. | String | ❌ |
| template | Specifies the template for the modal dialog box. The default value is
pzModalTemplate. | String | Required when the displayMode is set to
MODAL_DIALOG. |
| closeOnClickAway | Specifies if the overlay closes when the user clicks outside its
limits. The default value is true. | Boolean | ❌ |
| centerOverlay | Specifies if the overlay opens in the center of the screen. The default
value is false, which means that the overlay opens relative
to the event target. | Boolean | ❌ |
| isMobileFullScreen | Specifies if the flow action opens in full screen mode on mobile
devices. The default value is true. | Boolean | ❌ |
| revealEffectName | When isMobileFullScreen is set to
true, specifies the name of the animation that appears
when displaying the modal dialog or overlay. The following values are
available:
| Constant | ❌ |
| closingEffectName | When isMobileFullScreen is set to
true, specifies the name of the animation that appears
when closing the modal dialog or overlay. The following values are
available:
| Constant | ❌ |
Previous topic launchHarness Next topic openLocalAction