Represents a filter which can filter data based on one or two custom conditions. This filter type allows you to specify one or two filter conditions which have a comparison operator and value. These two filter conditions can be combined with a logical and or a logical or operation.

See

  • [[WorksheetTableColumn.filter]]
  • [[WorksheetTableColumn.applyCustomFilter]]
  • [[WorksheetTableColumn.applyCustomFilter]]
  • [[CustomFilterCondition]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get condition1(): CustomFilterCondition
  • Gets or sets the first condition by which to filter the cells in the data range.

    The first filter condition is required. Setting Condition1 to null will cause an exception to be thrown.

    When both Condition1 and [[condition2]] are set, the [[conditionalOperator]] is used to determine how the conditions should be logically combined.

    Throws

    [[ArgumentNullException]] The value assigned is null.

    See

    • [[condition2]]
    • [[conditionalOperator]]

    Returns CustomFilterCondition

  • set condition1(a): void
  • Parameters

    Returns void

  • get condition2(): CustomFilterCondition
  • Gets or sets the second condition by which to filter the cells in the data range.

    The second filter condition is optional. A value of null indicates that only [[condition1]] should be used to filter the data.

    When both Condition1 and Condition2 are set, the [[conditionalOperator]] is used to determine how the conditions should be logically combined.

    See

    • [[condition1]]
    • [[conditionalOperator]]

    Returns CustomFilterCondition

  • set condition2(a): void
  • Parameters

    Returns void

  • get conditionalOperator(): ConditionalOperator
  • Gets or sets the operator which defines how to logically combine [[condition1]] and [[condition2]]

    When both Condition1 and Condition2 are set, the ConditionalOperator is used to determine how the conditions should be logically combined. If only Condition1 is set and Condition2 is null, then ConditionalOperator is ignored.

    And to require both conditions to pass for the data to be filtered in. Or to allow data to be filtered in when one or both conditions are met.

    Throws

    [[InvalidEnumArgumentException]] The value assigned is not defined in the [[conditionalOperator]] enumeration.

    See

    • [[condition1]]
    • [[condition2]]

    Returns ConditionalOperator

  • set conditionalOperator(a): void
  • Parameters

    Returns void

Methods

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Returns Base

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean