addListItem
Adds a new item to a table or a repeating dynamic layout.
Signature
addListItem(options)
Returns
Not applicable.
Parameters
| Name | Description | Type | Required |
| target | Specifies the name of the target table, hierarchical list, hierarchical
table, or a repeating dynamic layout. The following values are available:
| Constant | ✅ |
| position | Specifies where the system adds the new row. The following values are
available:
| Constant | ❌ |
| event | Specifies the event that launches the activity. | DOM event object | ✅ |
| detailFlowAction | Specifies the flow action that displays the UI for the new item. | String | Required when the target parameter is set to
RDL |
| template | Specifies the template in which to display the
detailFlowAction. The default value is
pyNextGenGridModalTemplate. | String | Required when the target parameter is set to
RDL |
| dataPage | Specifies the name of the data page associated with the table or the repeating dynamic layout. When left empty, the event object identifies the target layout or table. | String | ❌ |
| dataPageResultsClass | Specifies the name of the class of the page specified in the dataPage parameter. | String | Required when dataPage parameter is set |
var options = {
target: pega.api.ui.constants.GRID / pega.api.ui.constants.RDL,
position: "sPosition",
event: eventObject,
detailFlowAction: 'flowActionName',
template: "templateName",
dataPage: "dataPageName" ,
dataPageResultsClass: 'className'
};
pega.api.ui.actions.list.addListItem(options);Previous topic Public JavaScript APIs Next topic editListItem