Class Multiselect

Simultaneous selection of multiple entries within two list elements. Entries are organized into selectable and selected lists, with intuitive functionality for moving entries between the two lists.

  • Selection Management: Allows for simultaneous selection of multiple entries across two distinct lists - 'selectable' and 'selected'.
  • Entry Interaction: Facilitates easy movement of entries between the 'selectable' and 'selected' lists.
  • Entry Search: Provides a search feature for quick and efficient selection from the 'selectable' list, especially useful when dealing with a large number of entries.

Hierarchy

  • Multiselect

Methods

getSearchedItems getSelectedItems hasSelectedItems loadItemsByGuid moveAllToSelected moveToSelected removeAllFromSelected removeFromSelected reset search selectItemsByGuid

Methods

getSearchedItems

  • Retrieves all items from the search pool.

    Returns UpGroovySelectOption[]

    Example

    var multiselect = ix.api.dom.getControl("<ELEMENT-GUID>");
    multiselect.getSearchedItems();

getSelectedItems

  • Retrieves all items from the selection pool.

    Returns UpGroovySelectOption[]

    Example

    var multiselect = ix.api.dom.getControl("<ELEMENT-GUID>");
    multiselect.getSelectedItems();

hasSelectedItems

  • Checks if there are any items in the selection pool.

    Returns boolean

    Example

    var multiselect = ix.api.dom.getControl("<ELEMENT-GUID>");
    multiselect.hasSelectedItems();

loadItemsByGuid

  • Searches for items by their GUIDs and moves them to the selection pool.

    Parameters

    • guidList: string[]

      An array of item GUIDs to be moved.

    Returns boolean | UpGroovySelectOption[]

    Example

    var multiselect = ix.api.dom.getControl("<ELEMENT-GUID>");
    multiselect.loadItemsByGuid(["<ITEM-GUID>", "<ITEM-GUID>"]);

moveAllToSelected

  • Moves all items from the search pool to the selection pool, irrespective of their selection status.

    Parameters

    • Optional triggerOnchange: boolean

      Whether to trigger the onchange event.

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<ELEMENT-GUID>");
    multiselect.moveAllToSelected(false);

moveToSelected

  • Moves only the selected items from the search pool to the selection pool.

    Parameters

    • Optional triggerOnchange: boolean

      Whether to trigger the onchange event.

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<ELEMENT-GUID>");
    multiselect.moveToSelected(false);

removeAllFromSelected

  • Moves all items from the selection pool back to the search pool, irrespective of their selection status.

    Parameters

    • Optional triggerOnchange: boolean

      Whether to trigger the onchange event.

    Returns void

    Default

    triggerOnchange = true

    Example

    var multiselect = ix.api.dom.getControl("<ELEMENT-GUID>");
    multiselect.removeAllFromSelected(false);

removeFromSelected

  • Moves the selected items from the selection pool back to the search pool.

    Parameters

    • Optional triggerOnchange: boolean

      Whether to trigger the onchange event.

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<ELEMENT-GUID>");
    multiselect.removeFromSelected(false);

reset

  • Resets the control, clearing all selections and search results.

    Parameters

    • Optional triggerOnchange: boolean

      Whether to trigger the onchange event.

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<ELEMENT-GUID>");
    multiselect.reset(false);

search

  • Performs a search with the given value and updates the search pool with matching items.

    Parameters

    • value: string

      Value to search for.

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<ELEMENT-GUID>");
    multiselect.search("John Doe");

selectItemsByGuid

  • Searches for specific items by their GUIDs and adds them to the selection pool, with an option to replace or append.

    Parameters

    • guidList: string[]

      Item list with their guids.

    • Optional modus: "append" | "replace"

      replace or append items in selected list.

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<ELEMENT-GUID>");
    multiselect.selectItemsByGuid(["<ITEM-GUID>", "<ITEM-GUID>"]);

Settings

Member Visibility

Theme

On This Page