IEditableCollectionView Interface
File
wijmo.js
Module
wijmo.collections
Implements
ICollectionView

Defines methods and properties that extend ICollectionView to provide editing capabilities.

Properties

canAddNew

Gets a value that indicates whether a new item can be added to the collection.

Type
boolean

canCancelEdit

Gets a value that indicates whether the collection view can discard pending changes and restore the original values of an edited object.

Type
boolean

canRemove

Gets a value that indicates whether items can be removed from the collection.

Type
boolean

currentAddItem

Gets the item that is being added during the current add transaction.

Type
T

currentEditItem

Gets the item that is being edited during the current edit transaction.

Type
T

isAddingNew

Gets a value that indicates whether an add transaction is in progress.

Type
boolean

isEditingItem

Gets a value that indicates whether an edit transaction is in progress.

Type
boolean

Methods

addNew

addNew(): any

Adds a new item to the collection.

Returns
any

cancelEdit

cancelEdit(): void

Ends the current edit transaction and, if possible, restores the original value to the item.

Returns
void

cancelNew

cancelNew(): void

Ends the current add transaction and discards the pending new item.

Returns
void

commitEdit

commitEdit(): void

Ends the current edit transaction and saves the pending changes.

Returns
void

commitNew

commitNew(): void

Ends the current add transaction and saves the pending new item.

Returns
void

editItem

editItem(item: T): void

Begins an edit transaction of the specified item.

Parameters
  • item: T

    Item to edit.

Returns
void

remove

remove(item: T): void

Removes the specified item from the collection.

Parameters
  • item: T

    Item to remove from the collection.

Returns
void

removeAt

removeAt(index: number): void

Removes the item at the specified index from the collection.

Parameters
  • index: number

    Index of the item to remove from the collection.

Returns
void