Collection.removeById

Удаляет элемент с указанным идентификатором из коллекции.

Description

Метод removeById() удаляет элемент с указанным идентификатором из коллекции. Успешное выполнение данного метода приводит к возникновению события onRemove. Вместе с этим событием также генерируется событие onChange, которое информирует о наличии любых изменений. Аргументы обеих событий в данном случае будут идентичны.

Syntax

Collection.removeById(id)

Parameters

Name Description
id Идентификатор элемента, который необходимо удалить из коллекции.

Returns

Возвращает true, если коллекция была изменена, иначе - false.

Examples

var collection = new Collection([
  { key: 1, value: 'A' },
  { key: 2, value: 'B' },
  { key: 3, value: 'C' }
], 'key');

collection.removeById(2);
collection.removeById(1);
collection.removeById(3);