Skip to main content

 –

launchLocalAction

Suggest edit Updated on July 21, 2021

Launches a local action as a modal dialog, an overlay, or by replacing the current section.

Signature

launchLocalAction(options)

Returns

Not applicable.

Parameters

NameDescriptionTypeRequired
flowActionSpecifies the name of the flow action that the API launches.String
displayModeSpecifies the target location for the local action. The following values are available:
  • pega.api.ui.constants.REPLACE_CURRENT: The default value, available only when you perform the assignment in the case.
  • pega.api.ui.constants.OVERLAY
  • pega.api.ui.constants.MODAL_DIALOG
Constant
eventSpecifies the event that launches the window.DOM event object
flowActionClassSpecifies the name of the class to which the flow action belongs.String
contextPageSpecifies the name of the context page for the flow action.String
skinFormatSpecifies the skin format for the overlay or the modal dialog box. The default value is Standard.String
templateSpecifies the template for the modal dialog box. The default value is pzModalTemplate.StringRequired when the displayMode is set to MODAL_DIALOG.
closeOnClickAwaySpecifies if the overlay closes when the user clicks outside its limits. The default value is true.Boolean
centerOverlaySpecifies 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
isMobileFullScreenSpecifies if the flow action opens in full screen mode on mobile devices. The default value is true.Boolean
revealEffectNameWhen 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:
  • From Bottom
  • Fade in
  • Grow
  • From left
  • From right
  • Shrink
  • From top
  • Vertical flip
Constant
closingEffectNameWhen 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:
  • From Bottom
  • Fade in
  • Grow
  • From left
  • From right
  • Shrink
  • From top
  • Vertical flip
Constant
For example:
var options = {
    flowAction: “flowActionName ",
    displayMode: pega.api.ui.constants.REPLACE_CURRENT / pega.api.ui.constants.OVERLAY / pega.api.ui.constants.MODAL_DIALOG ",
    event: eventObject,
    flowActionClass: "className",
    contextPage: "pageName",
    skinFormat: "skinFormat",
    template: "templateName",
    isMobileFullScreen: boolean,
    revealEffectName: "animtionName",
    closingEffectName: "animationName",
    closeOnClickAway: boolean,
    centerOverlay: boolean
};

pega.api.ui.actions.launchLocalAction(options);
Did you find this content helpful? YesNo

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us