Event Author API

itemlist:selection:changed

Fires when the author selects or deselects an Item on the Item list page, and also when the clearSelectedItems() method is called.

Important Only supported in "item_list" mode and when the Item selection initialization option is enabled.

Examples

authorApp.on('itemlist:selection:changed', function () {
    console.log('This code executes when the author selects or deselects an Item on the Item list page.');
});

Callback arguments

The event callback function will be called with an AuthorEvent instance as an argument (unless indicated otherwise). The AuthorEvent object provides further information for the event that has been fired. Additional data attributes listed below can be accessed from the event.data object. The AuthorEvent object will look like the example below:

authorApp.on('[name of the fired event]', function (event) {
    console.log(event);
    /*
        {
            "name": "[name of the fired event]",
            "data": {
                // additional data attributes
            }
        }
    */
});
  • itemReferences array
    The references of the selected Items.

Related articles

  • The mode initialization option, which is used to select the Item list mode.
  • The enable_selection initialization option, which is used allow Items to be selected on the Item list page.
Was this article helpful?