Feedback
Last date modified: 2025-Mar-10
ItemList Api
Includes methods for quickly accessing and modifying item lists. This API doesn't function properly until the hydrateLayoutComplete stage or later. These functions are available under the `convenienceApi.itemListHelper` namespace.
Methods
- setCommandColumnType(itemListIdentifier, commandColumnType) ⇒
Promise.<(undefined|null)> - Sets the
ITEM_LIST_COMMAND_COLUMN_TYPEfor the item list idenfitied byidentifiertocommandColumnType
Properties Details
setCommandColumnType(itemListIdentifier, commandColumnType) ⇒ Promise.<(undefined|null)>
Sets the ITEM_LIST_COMMAND_COLUMN_TYPE for the item list idenfitied by identifier to commandColumnType
Returns: Promise.<(undefined|null)> - A promise that resolves to undefined when the ITEM_LIST_COMMAND_COLUMN_TYPE has been set, or null if the set does not succeed
| Param | Type | Description |
|---|---|---|
| itemListIdentifier | Number | String | Object |
The identifier to use to look up the item list. See formViewModel.getFieldIdForField(identifier) for more details |
| commandColumnType | ITEM_LIST_COMMAND_COLUMN_TYPE
|
The `ITEM_LIST_COMMAND_COLUMN_TYPE to use. |
