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

  Returns boolean

calculateDeepDirty

• calculateDeepDirty(): boolean

  Returns boolean

calculateDirty

• calculateDirty(): boolean

  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

  Returns void

find

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

  Search by function among items

  Parameters

  • fn: (item: T) => boolean

  Returns undefined | T

find2

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

  Returns the found collection element or null Iteratively traverses the elements of the collection, and returns the first element of the collection for which callback returns true.

  Parameters

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

    search function

  Returns null | T

findIndex

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

  Find index of element or -1 by predicate (same as native findIndex method)

  Parameters

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

  Returns number

forEach

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

  Iteratively traverses the collection elements

  Parameters

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

    search function

  Returns void

get

• get(index: number): undefined | T

  Parameters

  • index: number

  Returns undefined | T

getAdded

• getAdded(): T[]

  Returns T[]

getByPropertyValues

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

  Parameters

  • propName: string
  • values: any[]

  Returns T[]

getCollectionDirty

• getCollectionDirty(): boolean

  Returns boolean

getCount

• getCount(): number

  Get the number of items in the collection

  Returns number

getDeepDirty

• getDeepDirty(): boolean

  Returns boolean

getDirty

• getDirty(): boolean

  Returns boolean

getOriginal

• getOriginal(): T[]

  Returns T[]

getRange

• getRange(): T[]

  Returns a new array containing all the items in the collection.

  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

  Returns the index of an item in the collection. If the item is not in the collection -1 is returned

  Parameters

  • item: T

  Returns number

insertAfter

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

  Inserts an element after an element

  Parameters

  • model: T

    Model
  • after: T

    the element to insert after

  Returns void

insertAt

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

  Inserts an item in the collection in the index position

  Parameters

  • model: T
  • index: number
  • OptionalskipValidation: boolean

  Returns void

insertBefore

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

  Inserts an element before the element

  Parameters

  • model: T

    Model
  • before: T

    the element to insert before

  Returns void

insertFirst

• insertFirst(model: T): void

  Inserts the item first in the collection

  Parameters

  • model: T

  Returns void

insertLast

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

  Inserts the item last in the collection

  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

  Moves item to new position

  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

  Replace an item in the collection in the index position

  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

  Parameters

  • phantom: boolean

  Returns void

setReactiveCascade

• setReactiveCascade(props: ReactiveProp[]): void

  Make all models in the collection and their properties reactive

  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

  Swaps items in the collection

  Parameters

  • a: T
  • b: T

  Returns void

updateCollectionDirty

• updateCollectionDirty(): void

  Returns void

updateDeepDirty

• updateDeepDirty(): void

  Returns void

updateDirty

• updateDirty(): void

  Returns void

validate

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

  Parameters

  • Optionaldeep: boolean

    flag for validate NOT only collection validators, but validators in each models in collection
  • OptionaldisablePropagation: boolean

    Parent cmp notification flag about validation

  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

  Returns ModelCollection<T>