Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IconSortCondition

Represents a sort condition which will sort cells based on a specific conditioanl formmat icon.

This sort condition specifies a single icon. Cells with this icon will be moved to the beginning of the data range for the ascending sort direction and moved to the end of the data range for the descending sort direction. All matching cells will be kept in their same relative order to each other. In addition, all non-matching cells will be kept in their same relative order to each other.

See

  • [[SortSettings`1.sortConditions]]
  • [[SortCondition.sortDirection]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static$t

$t: Type

StaticnextHashCode

nextHashCode: number

Accessors

iconIndex

  • get iconIndex(): number

  • The icon set (read-only).

    Returns number

iconSet

  • get iconSet(): FormatConditionIconSet

  • The icon's index in the associated icon set or null for 'NoCellIcon' (read-only).

    Returns FormatConditionIconSet

sortDirection

  • get sortDirection(): SortDirection

  • Gets the value which indicates the sort direction represented by the sort condition. Either SortDirection.Ascending or SortDirection.Descending.

    Returns SortDirection

Methods

equals

  • equals(obj): boolean

  • Determines whether the [[SortCondition]] is equal to the specified object.

    Parameters

    • obj: any

      The object to test for equality.

    Returns boolean

getHashCode

  • getHashCode(): number

  • Gets the hash code for the [[SortCondition]].

    Returns number

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

Staticcompare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

StaticcompareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

StaticequalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

StaticequalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

StaticgetArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

StaticgetArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

StaticgetHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

StaticreferenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean