Class ModelCollection<T>

constructor

• new ModelCollection<T extends AbstractModel<any>>(
      data: any[],
      descriptorConfig: IHasManyMainDescriptorConfig<T>,
      initConfig: Partial<ModelOptions>,
  ): ModelCollection<T>

  Type Parameters

  • T extends AbstractModel<any>

  Parameters

  • data: any[]
  • descriptorConfig: IHasManyMainDescriptorConfig<T>
  • initConfig: Partial<ModelOptions>

  Returns ModelCollection<T>

items

modelId

type

add

• add(item: T): ModelCollection<T>

  Добавляет элемент в коллекцию.

  Parameters

  • item: T

    Добавляемая модель.

  Returns ModelCollection<T>

addItems

• addItems(added: T[]): void

  Добавляет несколько элементов в коллекцию.

  Parameters

  • added: T[]

    Массив добавляемых моделей.

  Returns void

addValidator

• addValidator(validator: IFieldValidator): void

  Добавляет валидатор текущей коллекции.

  Parameters

  • validator: IFieldValidator

    Валидатор.

  Returns void

calculateCollectionDirty

• calculateCollectionDirty(): boolean

  Рассчитывает признак "collectionDirty".

  Returns boolean

calculateDeepDirty

• calculateDeepDirty(): boolean

  Рассчитывает признак "deepDirty".

  Returns boolean

calculateDirty

• calculateDirty(): boolean

  Рассчитывает общий признак "dirty".

  Returns boolean

clearCollection

• clearCollection(): void

  Очищает текущую коллекцию

  Returns void

clearValidationResult

• clearValidationResult(): void

  Очищает результаты валидации коллекции и всех её элементов.

  Returns void

clearValidators

• clearValidators(): void

  Очищает список валидаторов коллекции.

  Returns void

clone

• clone(): ModelCollection<T>

  Клонирует текущую коллекцию.

  Returns ModelCollection<T>

commit

• commit(): void

  Коммитит все изменения коллекции и её элементов.

  Returns void

commitCollection

• commitCollection(): void

  Коммитит изменения коллекции (добавленные, удалённые элементы, swaps).

  Returns void

find

• find(fn: (item: T) => boolean): undefined | T

  Ищет элемент в коллекции по заданной функции.

  Parameters

  • fn: (item: T) => boolean

    Функция поиска.

  Returns undefined | T

find2

• find2(callback: (item: T, index: number, items: T[]) => boolean): null | T

  Ищет в коллекции элемент, для которого callback вернёт true, или null если не найден.

  Parameters

  • callback: (item: T, index: number, items: T[]) => boolean

    Функция поиска.

  Returns null | T

findIndex

• findIndex(find: (item: T, index: number, items: T[]) => boolean): number

  Ищет индекс элемента, для которого callback возвращает true, или -1 если не найден.

  Parameters

  • find: (item: T, index: number, items: T[]) => boolean

    Функция поиска.

  Returns number

forEach

• forEach(callback: (item: T, index: number, items: T[]) => void): void

  Итеративно обходит элементы коллекции.

  Parameters

  • callback: (item: T, index: number, items: T[]) => void

    Функция обхода.

  Returns void

get

• get(index: number): undefined | T

  Возвращает элемент из коллекции по индексу или undefined, если элемент не существует.

  Parameters

  • index: number

    Индекс.

  Returns undefined | T

getAdded

• getAdded(): T[]

  Возвращает массив добавленных элементов.

  Returns T[]

getByPropertyValues

• getByPropertyValues(propName: string, values: any[]): T[]

  Возвращает массив элементов, чьё поле propName содержится в списке values.

  Parameters

  • propName: string

    Название поля.
  • values: any[]

    Массив значений.

  Returns T[]

getCollectionDirty

• getCollectionDirty(): boolean

  Возвращает признак изменена ли коллеция

  Returns boolean

getCount

• getCount(): number

  Возвращает количество элементов в коллекции.

  Returns number

getDeepDirty

• getDeepDirty(): boolean

  Возвращает признак "deepDirty".

  Returns boolean

getDirty

• getDirty(): boolean

  Возвращает признак изменен ли элемент.

  Returns boolean

getOriginal

• getOriginal(): T[]

  Возвращает массив исходных элементов.

  Returns T[]

getRange

• getRange(): T[]

  Возвращает копию массива элементов коллекции.

  Returns T[]

getRemoved

• getRemoved(): T[]

  Возвращает массив удалённых элементов.

  Returns T[]

getUpdated

• getUpdated(): T[]

  Возвращает массив обновлённых (призрачных или изменённых) элементов.

  Returns T[]

getValidationResult

• getValidationResult(level?: number): IValidationResult

  Возвращает результаты валидации коллекции.

  Parameters

  • Optionallevel: number

    Уровень вложенности.

  Returns IValidationResult

hasValidator

• hasValidator(validator: ClassCtor<IFieldValidator<AbstractModel<any>>>): boolean

  Проверяет, есть ли в коллекции валидатор указанного класса.

  Parameters

  • validator: ClassCtor<IFieldValidator<AbstractModel<any>>>

    Класс валидатора.

  Returns boolean

indexOf

• indexOf(item: T): number

  Возвращает индекс элемента в коллекции или -1, если элемент не найден.

  Parameters

  • item: T

    Модель.

  Returns number

insertAfter

• insertAfter(model: T, after: T): void

  Вставляет элемент после указанного элемента.

  Parameters

  • model: T

    Модель.
  • after: T

    Элемент, после которого вставляем.

  Returns void

insertAt

• insertAt(model: T, index: number, skipValidation?: boolean): void

  Вставляет элемент в коллекцию по индексу.

  Parameters

  • model: T

    Модель.
  • index: number

    Индекс вставки.
  • OptionalskipValidation: boolean

    Флаг пропуска валидации.

  Returns void

insertBefore

• insertBefore(model: T, before: T): void

  Вставляет элемент перед указанным элементом.

  Parameters

  • model: T

    Модель.
  • before: T

    Элемент перед которым вставляем.

  Returns void

insertFirst

• insertFirst(model: T): void

  Вставляет элемент в начало коллекции.

  Parameters

  • model: T

    Модель.

  Returns void

insertLast

• insertLast(model: T, skipValidation?: boolean): void

  Вставляет элемент в конец коллекции.

  Parameters

  • model: T

    Модель.
  • OptionalskipValidation: boolean

    Флаг пропуска валидации.

  Returns void

isEqual

• isEqual(collection: ModelCollection<T>, config?: EqualConfig): boolean

  Сравнивает текущую коллекцию с переданной коллекцией.

  Parameters

  • collection: ModelCollection<T>

    Другая коллекция для сравнения.
  • Optionalconfig: EqualConfig

    Опции сравнения.

  Returns boolean

moveItem

• moveItem(oldIndex: number, newIndex: number): void

  Перемещает элемент коллекции в новую позицию.

  Parameters

  • oldIndex: number

    Текущий индекс.
  • newIndex: number

    Новый индекс.

  Returns void

onItemValidation

• onItemValidation(modelId: number, validationResult: IValidationResult): void

  Вызывается при изменении валидации в элементе коллекции.

  Parameters

  • modelId: number

    Идентификатор модели.
  • validationResult: IValidationResult

    Результаты валидации.

  Returns void

remove

• remove(item: T): ModelCollection<T>

  Удаляет элемент из коллекции.

  Parameters

  • item: T

    Модель.

  Returns ModelCollection<T>

removeAll

• removeAll(): ModelCollection<T>

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

  Returns ModelCollection<T>

removeAt

• removeAt(index: number): ModelCollection<T>

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

  Parameters

  • index: number

    Индекс.

  Returns ModelCollection<T>

replaceAll

• replaceAll(added: T[]): ModelCollection<T>

  Заменяет все элементы коллекции.

  Parameters

  • added: T[]

    Массив новых элементов.

  Returns ModelCollection<T>

replaceAt

• replaceAt(model: T, index: number, skipValidation?: boolean): void

  Заменяет элемент в коллекции по индексу.

  Parameters

  • model: T

    Модель.
  • index: number

    Индекс.
  • OptionalskipValidation: boolean

    Флаг пропуска валидации.

  Returns void

revert

• revert(): void

  Откатывает все изменения коллекции и её элементов.

  Returns void

serialize

• serialize(config?: any): object[]

  Сериализует коллекцию в массив объектов.

  Parameters

  • Optionalconfig: any

    Опции сериализации.

  Returns object[]

setAdded

• setAdded(added: T[]): void

  Устанавливает список добавленных элементов.

  Parameters

  • added: T[]

    Массив добавленных моделей.

  Returns void

setOriginal

• setOriginal(original: T[]): void

  Устанавливает исходную коллекцию.

  Parameters

  • original: T[]

    Массив исходных моделей.

  Returns void

setPhantomCascade

• setPhantomCascade(phantom: boolean): void

  Устанавливает флаг "phantom" для всех моделей коллекции.

  Parameters

  • phantom: boolean

    Значение для установки.

  Returns void

setReactiveCascade

• setReactiveCascade(props: ReactiveProp[]): void

  Делает все модели в коллекции и их свойства реактивными.

  Parameters

  • props: ReactiveProp[]

    Массив свойств для реактивного преобразования.

  Returns void

setRemoved

• setRemoved(removed: T[]): void

  Устанавливает список удалённых элементов.

  Parameters

  • removed: T[]

    Массив удалённых моделей.

  Returns void

size

• size(): number

  Возвращает размер коллекции.

  Returns number

sort

• sort(compareFn?: (a: T, b: T) => number): void

  Сортирует элементы коллекции.

  Parameters

  • OptionalcompareFn: (a: T, b: T) => number

    Функция сравнения.

  Returns void

swapItems

• swapItems(a: T, b: T): void

  Меняет местами два элемента коллекции.

  Parameters

  • a: T

    Первый элемент.
  • b: T

    Второй элемент.

  Returns void

updateCollectionDirty

• updateCollectionDirty(): void

  Обновляет признак "collectionDirty".

  Returns void

updateDeepDirty

• updateDeepDirty(): void

  Обновляет признак dirty глубоко

  Returns void

updateDirty

• updateDirty(): void

  Обновляет признак "dirty" коллекции.

  Returns void

validate

• validate(deep?: boolean, disablePropagation?: boolean): IValidationResult

  Выполняет валидацию коллекции.

  Parameters

  • Optionaldeep: boolean

    Флаг, указывающий выполнять ли валидацию как коллекции, так и всех моделей.
  • OptionaldisablePropagation: boolean

    Флаг запрещающий уведомлять родительский компонент о валидации.

  Returns IValidationResult

Staticcreate

• create<T extends AbstractModel<any>>(
      type: ClassCtor<T>,
      onChangeDirty?: () => void,
  ): ModelCollection<T>

  Создаёт новую коллекцию указанного типа.

  Type Parameters

  • T extends AbstractModel<any>

  Parameters

  • type: ClassCtor<T>

    Класс модели.
  • OptionalonChangeDirty: () => void

    Обработчик изменения признака "dirty".

  Returns ModelCollection<T>