Class ListModel<T>

constructor

• new ListModel<T>(options: ListModelOptions<T>): ListModel<T>

  Type Parameters

  • T

  Parameters

  • options: ListModelOptions<T>

  Returns ListModel<T>

Optional Readonlyactivity

Optional Readonlycontext

Optional Readonlyodata

allItems

• get allItems(): readonly T[] | undefined

  A readonly array of all items if this is an in-memory list model.

  To modify items in memory, either replace the entire list model or use the API supported by the list model.

  Returns readonly T[] | undefined

countPromise

• get countPromise(): Promise<void>

  A promise that resolves when the total count is loaded.

  This promise may be replaced at any time even if the previous one is not yet resolved.

  Returns Promise<void>

hasNextPage

• get hasNextPage(): boolean

  True, if there is a next page.

  Returns boolean

isUnknownPageCount

• get isUnknownPageCount(): boolean

  True, if the total count is permanently unknown.

  Returns boolean

items

• get items(): readonly T[]

  Get the current page of items.

  Returns readonly T[]

  The current page all items if paging is disabled.

pageCount

• get pageCount(): number | undefined

  Get the total number of pages.

  Returns number | undefined

  The number of pages or undefined if paging is disabled or the total item count is not yet known. This returns at least 1 if there are no items.

pageIndex

• get pageIndex(): number

  Get the current page index.

  Returns number

• set pageIndex(value: number): void

  Set the current page index.

  Parameters

  • value: number

  Returns void

pagePromise

• get pagePromise(): Promise<void>

  A promise that resolves when the current page is loaded.

  This promise may be replaced at any time even if the previous one is not yet resolved.

  Returns Promise<void>

pageSize

• get pageSize(): number | null

  Get the number of items per page.

  Returns number | null

  The page size or null if paging is disabled.

selectedCount

• get selectedCount(): number

  Get the current number of selected indices.

  Returns number

selectedItem

• get selectedItem(): T | undefined

  Get the first selected item.

  Returns T | undefined

singleSelectedIndex

• get singleSelectedIndex(): number | undefined

  Get the only selected index within the current page.

  Returns number | undefined

  The index or undefined if there isn't exactly one selected index.

totalCount

• get totalCount(): number | undefined

  Get the total item count.

  Returns number | undefined

  The total count or undefined if it is not yet known.

abort

• abort(): void

  Abort the current page request.

  Returns void

clearSelection

• clearSelection(): void

  Clear the selection.

  Returns void

cloneInMemory

• cloneInMemory(mapItem?: (item: T) => T): ListModel<T>

  Create a clone of this in-memory list model.

  • The current selection is preserved.
  • Paging is not preserved.

  Parameters

  • OptionalmapItem: (item: T) => T

    Optional function to process each item. By default, all items are re-used.

  Returns ListModel<T>

getSelectedIndices

• getSelectedIndices(): number[]

  Get a sorted array of all selected indices on the current page.

  Returns number[]

getSelectedItems

• getSelectedItems(): T[]

  Get an array of all selected items in any order.

  Returns T[]

isSelectedIndex

• isSelectedIndex(index: number): boolean

  Check if the specified index is selected.

  Parameters

  • index: number

  Returns boolean

moveSelectedItemDown

• moveSelectedItemDown(): void

  Move the currently selected item down.

  Returns void

moveSelectedItemUp

• moveSelectedItemUp(): void

  Move the currently selected item up.

  Returns void

queueTaskAfterRefresh

• queueTaskAfterRefresh(task: () => void): void

  Queue a task to run once when this list model has been refreshed.

  Parameters

  • task: () => void

  Returns void

refresh

• refresh(): void

  Schedule refreshing the current page in the next microtask.

  Returns void

removeFromPageAtIndex

• removeFromPageAtIndex(index: number): void

  Remove an item by it's index on the current page.

  • This also clears the selection.
  • When the current page is empty after removing, the previous page is loaded.

  Parameters

  • index: number

  Returns void

  Throws

  An error if this is a remote list model or the index is out of range.

selectAll

• selectAll(): void

  Select all items.

  Returns void

selectItemsFrom

• selectItemsFrom(other: ListModel<T>): void

  Copy the selection from another list model.

  Parameters

  • other: ListModel<T>

  Returns void

selectSingleIndex

• selectSingleIndex(index: number): boolean

  Select a single item at the specified index.

  Parameters

  • index: number

  Returns boolean

  False if the index was out of range.

selectSingleItem

• selectSingleItem(item: T): void

  Select a single item.

  Parameters

  • item: T

  Returns void

selectSingleRange

• selectSingleRange(from: number, to: number): void

  Select a single range of items by index.

  Indices may be specified in any order and may be out of range.

  Parameters

  • from: number

    The inclusive start index.

  • to: number

    The inclusive to index.

  Returns void

setSelection

• setSelection(indices: number[]): void

  Set the selection. This replaces the entire selection.

  Parameters

  • indices: number[]

    The indices to select. Indices out of range are ignored.

  Returns void

sort

• sort(...options: SortOption<T>[]): void

  Apply sorting to this model.

  If this is a remote model, the sorting is applied to the context, else the allItems array is sorted in memory.

  Parameters

  • ...options: SortOption<T>[]

  Returns void

toggleRange

• toggleRange(from: number, to: number, select?: boolean): void

  Toggle the selection of a range of items by index. Previously selected items outside the range are preserved.

  Parameters

  • from: number

    The inclusive start index.

  • to: number

    The inclusive end index. If this index will toggle to selected, all items in the range are selected, else all items in the range are deselected.

  • Optionalselect: boolean

    Wether to select or deselect the range or undefined to toggle.

  Returns void

toggleSelectedIndex

• toggleSelectedIndex(index: number, select?: boolean): boolean

  Toggle the selection at a specific index.

  Parameters

  • index: number

    The index to toggle. This may be out of range.

  • Optionalselect: boolean

    Wether to select or deselect the index or undefined to toggle.

  Returns boolean