Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class SortSettings$1<T>

Represents the settings which apply to sorting a region of values.

See

WorksheetTable.sortSettings

Type Parameters

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Type parameters

    Type Parameters

    Parameters

    • $t: Type
    • a: ISortSettingsOwner
    • b: ((arg1: T) => void)
        • (arg1: T): void

        • Parameters

          • arg1: T

          Returns void

    Returns SortSettings$1<T>

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

caseSensitive

  • get caseSensitive(): boolean

  • Gets or sets the value which indicates whether strings should be compared case-sensitively when they are sorted.

    This is only applicable to sort conditions which sort strings.

    True to sort strings case-sensitively; False to ignore case.

    Returns boolean

  • set caseSensitive(a: boolean): void

  • Parameters

    • a: boolean

    Returns void

Methods

equals

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • Returns number

memberwiseClone

sortConditions

  • 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

  • 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>

  • Gets the collection of sort conditions to use when sorting the region of data.

    If these settings are used in a WorksheetTable, each sort condition in the collection applies to a WorksheetTableColumn.

    This collection is ordered based on precedence. The first sort condition in the collection has the highest sort precedence.

    See

    WorksheetTableColumn.sortCondition

    Returns SortConditionCollection$1<T>

Static compare

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • Parameters

    • a: any
    • b: any

    Returns boolean