Represents a filter which can filter in cells in the upper or lower portion of the sorted values.

See

  • [[WorksheetTableColumn.filter]]
  • [[WorksheetTableColumn.applyTopOrBottomFilter]]
  • [[WorksheetTableColumn.applyTopOrBottomFilter]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get type(): TopOrBottomFilterType
  • Gets or sets the type of the filter. TopValues or BottomValues to filter in the top or bottom N value in the list of sorted values; TopPercentage or BottomPercentage to filter in the top or bottom N percentage of values in the list of sorted values.

    Throws

    [[InvalidEnumArgumentException]] The value assign is not defined in the [[TopOrBottomFilterType]] enumeration.

    See

    [[value]]

    Returns TopOrBottomFilterType

  • set type(a): void
  • Parameters

    Returns void

  • get value(): number
  • Gets or sets the number or percentage of value of values which should be filtered in.

    When [[type]] is TopValues or BottomValues, Value indicates the number of value which should be filtered in. When Type is TopPercentage or BottomPercentage, Value indicates percentage to filter in. For example, a Value of 15 and a Type of BottomPercentage will filter in the bottom 15 percent of values.

    The number or percentage of items which should be filtered in.

    Throws

    [[ArgumentOutOfRangeException]] The value assigned is less than 1 or greater than 500.

    Returns number

  • set value(a): void
  • Parameters

    • a: number

    Returns void

Methods

  • Parameters

    • other: any

    Returns boolean

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

  • Parameters

    • a: any
    • b: any

    Returns boolean