clearSelectedItems - Methods - Author API

Author API Methods

clearSelectedItems()

Deselect all the previously selected Items in the Item list view.

You would want to use this method so that you can build a custom list selection UI in your application, for example.

Important The enable_selection initialization option must be set to true for this method to function.

Examples

var clearResult = authorApp.clearSelectedItems();
console.log(clearResult);

Arguments

None.

Return value

Type boolean

Returns true if one or more Items were deselected, otherwise returns false.

Related articles

  • The enable_selection initialization option, which allows authors to select multiple Items in the Item list view.
  • The getSelectedItems() method, which gets the selected Items in the Item list view.
Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.