Skip to main content
LinkedIn
Copied!

Table of Contents

refreshSection

Version:

Only available versions of this content are shown in the dropdown

Refreshes a section. When refreshing a target section, the system refreshes all sections that share the name of the target section.

Signature

refreshSection(options)

Returns

Not applicable.

Parameters

Name Description Type Required
section Specifies the name of the section that you want to refresh. By default, the API refreshes the section that contains the element that raises the event. String
event Specifies the event that launches the activity. DOM event object
dataTransform Specifies the name and parameters of the data transform. JSON object
activity Specifies the activity that the section launches on refresh. JSON object
submitOnRefresh Specifies if the system submits editable data from the form to the clipboard. The default value is true. Boolean

JSON objects

dataTransform
Includes an array of parameter objects. isProperty indicates whether the parameter is a property or a literal constant. The default value of isProperty is false, which means that the parameter is a constant.
{
   "name":"dataTransformName",
   "parameters":[
      {
         "name":"param1",
         "value":"Page1.prop1",
         "isProperty":true
      },
      {
         "name":"param2",
         "value":123,
         "isProperty":false
      }
   ]
}
activity
Includes an array of parameter objects. isProperty indicates whether the parameter is a property or a literal constant. The default value of isProperty is false, which means that the parameter is a constant.
{
   "name":"activityName",
   "parameters":[
      {
         "name":"param1",
         "value":"Page1.prop1",
         "isProperty":true
      },
      {
         "name":"param2",
         "value":123,
         "isProperty":false
      }
   ]
}
var options = {      
              section: sectionName,
              event: eventObject,
              dataTransform: dataTransformJSONObject,
              activity: activityJSONObject,
              submitOnRefresh: boolean
          }; 

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

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 Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice
Contact us