Skip to content

ObservableCollection

github-actions[bot] edited this page Nov 17, 2024 · 2 revisions
API / ObservableCollection<TItem> class

Represents an observable collection based on the Array interface.

Extends ReadOnlyObservableCollection<TItem>.
Implements IObservableCollection<TItem>.

class ObservableCollection<TItem>
    extends ReadOnlyObservableCollection<TItem>
    implements IObservableCollection<TItem>

Source reference: src/collections/observableCollections/ObservableCollection.ts:9.

Generic Parameters

  • TItem - The type of items the collection contains.

Constructors

Properties

  • override length - Gets or sets the number of items in the collection.
  • inherited readonly collectionChanged - An event that is raised when the collection changed by adding or removing items.
  • inherited readonly collectionReordered - An event that is raised when the collection is reordered.
  • inherited propertiesChanged - An event that is raised when one or more properties may have changed.

Methods

  • override copyWithin - Copies items inside the collection overwriting existing ones.
  • override fill - Fills the collection with the provided item.
  • override get - Gets the item at the provided index.
  • override pop - Removes the last element from the collection and returns it. If the collection is empty, undefined is returned.
  • override push - Appends new elements to the end of the collection, and returns the new length of the collection.
  • override reverse - Reverses the items in the collections and returns the observable collection..
  • override set - Sets the provided item at the provided index.
  • override shift - Removes the first element from the collection and returns it. If the collection is empty, undefined is returned.
  • override sort - Reverses the items in the collections and returns the observable collection.
  • override splice - Removes and/or adds elements to the collection and returns the deleted elements.
  • override unshift - Inserts new elements at the start of the collection, and returns the new length of the collection.

Inheritance Hierarchy

See also

Clone this wiki locally