Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class SortConditionCollection$1<T>

An ordered collection of sort conditions which are applied to a sort-able regions in a worksheet.

The sort conditions in the collection are applied in order to the data.

Note: The collection can hold a maximum of 64 sort condition.

See

[[SortSettings`1.sortConditions]]

Type Parameters

Hierarchy

Hierarchy

  • Base
    • SortConditionCollection$1

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

count

  • get count(): number

  • Gets the number of sort conditions in the collection.

    Returns number

Methods

[iterator]

  • [iterator](): EnumeratorWrapper<KeyValuePair$2<T, SortCondition>>

  • Returns EnumeratorWrapper<KeyValuePair$2<T, SortCondition>>

addItem

  • addItem(sortableItem, sortCondition): void

  • Adds a sort condition to the collection.

    Throws

    [[ArgumentNullException]] 'sortableItem' is null.

    Throws

    [[ArgumentNullException]] 'sortCondition' is null.

    Throws

    [[ArgumentException]] 'sortableItem' is already has a sort condition applied to it in the collection.

    Throws

    [[InvalidOperationException]] There are already 64 sort conditions in the collection.

    Parameters

    • sortableItem: T

      The sort-able item over which the sort condition will be applied.

    • sortCondition: SortCondition

      The sort condition to apply to the sort-able item.

    Returns void

addRange

  • addRange(entries): void

  • Adds a range of sort conditions to the collection.

    Throws

    [[ArgumentNullException]] 'entries' is null.

    Throws

    [[ArgumentNullException]] If any sort condition is null.

    Throws

    [[ArgumentException]] If any sortable item is already has a sort condition applied to it in the collection.

    Throws

    [[InvalidOperationException]] There are already 64 sort conditions in the collection.

    Parameters

    • entries: IEnumerable$1<KeyValuePair$2<T, SortCondition>>

      An enumberable of entries which contain the sort-able item over which the sort condition will be applied and the sort condition to apply to the sort-able item.

    Returns void

clear

  • clear(): void

  • Clears the collection.

    Returns void

contains

  • contains(sortCondition): boolean

  • Determines whether the specified sort condition is in the collection.

    Throws

    [[ArgumentNullException]] 'sortCondition' is null.

    Parameters

    • sortCondition: SortCondition

      The sort condition to find in the collection.

    Returns boolean

  • contains(sortableItem): boolean

  • Determines whether the specified sort-able item is in the collection.

    Throws

    [[ArgumentNullException]] 'sortableItem' is null.

    Parameters

    • sortableItem: T

      The sort-able item to find in the collection.

    Returns boolean

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • getHashCode(): number

  • Returns number

indexOf

  • indexOf(sortCondition): number

  • Gets the index of the specified sort condition in the collection.

    Throws

    [[ArgumentNullException]] 'sortCondition' is null.

    Parameters

    • sortCondition: SortCondition

      The sort condition to find in the collection.

    Returns number

  • indexOf(sortableItem): number

  • Gets the index of the specified sort-able item in the collection.

    Throws

    [[ArgumentNullException]] 'sortableItem' is null.

    Parameters

    • sortableItem: T

      The sort-able item to find in the collection.

    Returns number

insert

  • insert(index, sortableItem, sortCondition): void

  • Inserts a sort condition into the collection.

    Throws

    [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than [[count]].

    Throws

    [[ArgumentNullException]] 'sortableItem' is null.

    Throws

    [[ArgumentNullException]] 'sortCondition' is null.

    Throws

    [[ArgumentException]] 'sortableItem' is already has a sort condition applied to it in the collection.

    Throws

    [[InvalidOperationException]] There are already 64 sort conditions in the collection.

    Parameters

    • index: number

      The 0-based index where the sort condition should be inserted.

    • sortableItem: T

      The sort-able item over which the sort condition will be applied.

    • sortCondition: SortCondition

      The sort condition to apply to the sort-able item.

    Returns void

insertRange

  • insertRange(index, entries): void

  • Inserts a range of sort conditions into the collection.

    Throws

    [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than [[count]].

    Throws

    [[ArgumentNullException]] 'entries' is null.

    Throws

    [[ArgumentNullException]] If any sort condition is null.

    Throws

    [[ArgumentException]] If any sortable item is already has a sort condition applied to it in the collection.

    Throws

    [[InvalidOperationException]] There are already 64 sort conditions in the collection.

    Parameters

    • index: number

      The 0-based index where the sort condition should be inserted.

    • entries: IEnumerable$1<KeyValuePair$2<T, SortCondition>>

      An enumberable of entries which contain the sort-able item over which the sort condition will be applied and the sort condition to apply to the sort-able item.

    Returns void

item

  • item(sortableItem, value?): SortCondition

  • Gets or sets the sort condition for the specified sort-able item.

    Throws

    [[ArgumentNullException]] 'sortableItem' is null.

    Throws

    [[InvalidOperationException]] The sort-able item is not already in the collection and there are already 64 sort conditions in the collection.

    Parameters

    • sortableItem: T

      The sort-able item for which to get or set the sort condition.

    • Optional value: SortCondition

    Returns SortCondition

  • item(index, value?): KeyValuePair$2<T, SortCondition>

  • Gets or sets the pair of item and sort condition at the specified index.

    Throws

    [[ArgumentNullException]] The Key or Value of the assigned value is null.

    Throws

    [[InvalidOperationException]] The Key of the assigned value already in the collection at a different index.

    Parameters

    • index: number

      The index at which to get the pair of item and sort condition.

    • Optional value: KeyValuePair$2<T, SortCondition>

    Returns KeyValuePair$2<T, SortCondition>

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

remove

  • remove(sortCondition): boolean

  • Removes a sort condition from the collection.

    Throws

    [[ArgumentNullException]] 'sortCondition' is null.

    Parameters

    • sortCondition: SortCondition

      The sort condition to remove from the collection.

    Returns boolean

removeAt

  • removeAt(index): void

  • Removes the sort condition at the specified index.

    Throws

    [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than or equal to [[count]].

    Parameters

    • index: number

      The 0-based index of the sort condition to remove.

    Returns void

removeItem

  • removeItem(sortableItem): boolean

  • Removes a sort-able item from the collection.

    Throws

    [[ArgumentNullException]] 'sortableItem' is null.

    Parameters

    • sortableItem: T

      The sort-able item to remove from the collection.

    Returns boolean

replaceAll

  • replaceAll(entries): void

  • Clears the existing sort conditions from the collection and replaces them with new entries in a single atomic operation.

    Throws

    [[ArgumentNullException]] 'entries' is null.

    Throws

    [[ArgumentNullException]] If any sort condition is null.

    Throws

    [[ArgumentException]] If any sortable item is already has a sort condition applied to it in the collection.

    Throws

    [[InvalidOperationException]] There are more than 64 sort conditions.

    Parameters

    • entries: IEnumerable$1<KeyValuePair$2<T, SortCondition>>

      An enumberable of entries which contain the sort-able item over which the sort condition will be applied and the sort condition to apply to the sort-able item.

    Returns void

Static compare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean