LayoutItemCollection Class
File
c1.nav.js
Module
c1.nav
Base Class
ObservableArray

Defines the class which represents the collection of the layoutitems.

Constructor

constructor

constructor(parent?: any): LayoutItemCollection

Initializes a new LayoutItemCollection.

Parameters
  • parent: any Optional

    The object owns this collection.

Returns
LayoutItemCollection

Properties

isUpdating

Gets a value that indicates whether notifications are currently suspended (see beginUpdate and endUpdate).

Inherited From
ObservableArray
Type

Methods

beginUpdate

beginUpdate(): void

Suspends notifications until the next call to endUpdate.

Inherited From
ObservableArray
Returns
void

clear

clear(): void

Removes all items from the array.

Inherited From
ObservableArray
Returns
void

deferUpdate

deferUpdate(fn: Function): void

Executes a function within a beginUpdate/endUpdate block.

The collection will not be refreshed until the function finishes. This method ensures endUpdate is called even if the function throws an exception.

Parameters
  • fn: Function

    Function to be executed without updates.

Inherited From
ObservableArray
Returns
void

endUpdate

endUpdate(): void

Resumes notifications suspended by a call to beginUpdate.

Inherited From
ObservableArray
Returns
void

implementsInterface

implementsInterface(interfaceName: string): boolean

Returns true if the caller queries for a supported interface.

Parameters
  • interfaceName: string

    Name of the interface to look for.

Inherited From
ObservableArray
Returns
boolean

indexOf

indexOf(searchElement: T, fromIndex?: number): number

Searches for an item in the array.

Parameters
  • searchElement: T

    Element to locate in the array.

  • fromIndex: number Optional

    The index where the search should start.

Inherited From
ObservableArray
Returns
number

insert

insert(index: number, item: T): void

Inserts an item at a specific position in the array.

Parameters
  • index: number

    Position where the item will be added.

  • item: T

    Item to add to the array.

Inherited From
ObservableArray
Returns
void

onCollectionChanged

onCollectionChanged(e?: NotifyCollectionChangedEventArgs): void

Raises the collectionChanged event.

Parameters
Returns
void

push

push(...item: any[]): number

Adds one or more items to the end of the array.

Parameters
  • ...item: any[]

    One or more items to add to the array.

Returns
number

remove

remove(item: T): boolean

Removes an item from the array.

Parameters
  • item: T

    Item to remove.

Inherited From
ObservableArray
Returns
boolean

removeAt

removeAt(index: number): void

Removes an item at a specific position in the array.

Parameters
  • index: number

    Position of the item to remove.

Inherited From
ObservableArray
Returns
void

setAt

setAt(index: number, item: any): void

Assigns an item at a specific position in the array.

Parameters
  • index: number

    Position where the item will be assigned.

  • item: any

    Item to assign to the array.

Returns
void

shift

shift(): T

Removes the first element from the array and returns that element.

This method changes the length of the array.

Inherited From
ObservableArray
Returns
T

slice

slice(begin?: number, end?: number): T[]

Creates a shallow copy of a portion of an array.

Parameters
  • begin: number Optional

    Position where the copy starts.

  • end: number Optional

    Position where the copy ends.

Inherited From
ObservableArray
Returns
T[]

sort

sort(compareFn?: Function): this

Sorts the elements of the array in place.

Parameters
  • compareFn: Function Optional

    Specifies a function that defines the sort order. If specified, the function should take two arguments and should return -1, +1, or 0 to indicate the first argument is smaller, greater than, or equal to the second argument. If omitted, the array is sorted in dictionary order according to the string conversion of each element.

Inherited From
ObservableArray
Returns
this

splice

splice(index: number, count: number, item?: any): any[]

Removes and/or adds items to the array.

Parameters
  • index: number

    Position where items will be added or removed.

  • count: number

    Number of items to remove from the array.

  • item: any Optional

    Item to add to the array.

Returns
any[]

unshift

unshift(...items: T[]): number

Adds one or more elements to the beginning of the array and returns the new length of the array.

Parameters
  • ...items: T[]

    One or more items to add to the array.

Inherited From
ObservableArray
Returns
number

Events

collectionChanged

Occurs when the collection changes.

Inherited From
ObservableArray
Arguments
NotifyCollectionChangedEventArgs