Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IconFilter

Represents a filter which can filter cells based on their conditional formatting icon.

This filter allows cells to be filtered in if their conditional formatting icon matches the criteria.

See

  • [[WorksheetTableColumn.filter]]
  • [[ConditionalFormatCollection.addIconSetCondition]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new IconFilter(a, b, c): IconFilter

  • Parameters

    • a: IFilterable
    • b: ST_IconSetType
    • c: Nullable$1<number>

    Returns IconFilter

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

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

Methods

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • getHashCode(): number

  • Returns number

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

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