This content has been archived and is no longer being maintained.

Table of Contents

Article

launchLocalAction: Public JS API for Actions

launchLocalAction

Launch a local action either as a modal dialog, overlay or by replace the current section.

Syntax

var options ={<br />
flowAction: “flowActionName ",<br />
displayMode: pega.api.ui.constants.REPLACE_CURRENT / pega.api.ui.constants.OVERLAY / pega.api.ui.constants.MODAL_DIALOG"
,<br />
event: eventObject,<br />
flowActionClass:"className",<br />
contextPage:"pageName",<br />
skinFormat:"skinFormat",<br />
template:"templateName",<br />
isMobileFullScreen:true/false,<br />
revealEffectName:"animtionName",<br />
closingEffectName:"animtionName",<br />
closeOnClickAway:true/false,<br />
centerOverlay:true/false<br />
};

pega.api.ui.actions.launchLocalAction(options);

Parameters

This API accepts a JavaScript object which can have the following key-values.

  • flowAction: Flow action name
  • displayMode: Optional. The following are valid values:
    • pega.api.ui.constants.REPLACE_CURRENT
    • pega.api.ui.constants.OVERLAY
    • pega.api.ui.constants.MODAL_DIALOG
    • pega.api.ui.constants.REPLACE_CURRENT option is supported only when you are performing the assignment in case. The default value is pega.api.ui.constants.REPLACE_CURRENT.
  • event: The event refers to a DOM eventObject.
  • flowActionClass: Flow Action class
  • contextPage: Optional. This string specifies the name of the context page to render flow action.
  • skinFormat: Optional. This string specifies the skin format name. The default value is Standard. This is respected only when the displayMode is Overlay / Modal Dialog
  • template: Optional. Applicable when displayMode is Modal Dialog. Use this to specify the modal dialog template. The default value is pzModalTemplate. This is required only when the displayMode is Modal Dialog.
  • closeOnClickAway: Optional. Applicable when the displayMode is Overlay. Use a Boolean value to specify if the overlay should be dismissed when the user clicks outside the overlay. The default value is true.
  • centerOverlay: Optional. Applicable when the displayMode is Overlay. Use a Boolean to indicate if the overlay should be positioned in the center of the screen rather than relative to the event target. The default value is false.
  • isMobileFullScreen: Optional. Display full screen or not on mobile. The default value is true.
  • revealEffectName: Optional. This is applicable only when isMobileFullScreen is true. Indicates the name of the animation to be applied when displaying the modal dialog or overlay. Valid values are:
    • From Bottom
    • Fade in
    • Grow
    • From left
    • From right
    • Shrink
    • From top
    • Vertical flip
  • closingEffectName: Optional. Only applicable when isMobileFullScreen is true. Name of the animation to be applied when dismissing the modal dialog or overlay. Valid values are:
    • Reverse the reveal effect
    • To top
    • To bottom
    • To left
    • To right
    • Shrink
    • Grow
    • Vertical flip
    • Fade out

Published February 15, 2017 — Updated April 6, 2017


75% found this useful

Have a question? Get answers now.

Visit the Pega Support Community to ask questions, engage in discussions, and help others.