Represents a filter which can filter dates in a specific period.

This filter allows dates to be filtered in if they are in a specific month or quarter of any year.

See

  • [[WorksheetTableColumn.filter]]
  • [[WorksheetTableColumn.applyDatePeriodFilter]]
  • [[WorksheetTableColumn.applyDatePeriodFilter]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get type(): DatePeriodFilterType
  • Gets or sets the type of date period to filter in. Month to filter in dates in a specific month of any year; Quarter to filter in dates in a specific quarter of any year.

    Throws

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

    Throws

    [[ArgumentException]] The value assigned is Quarter and the [[value]] is less than 1 or greater than 4 or the value assigned is Month and the Value is less than 1 or greater than 12.

    See

    [[value]]

    Returns DatePeriodFilterType

  • set type(a): void
  • Parameters

    Returns void

  • get value(): number
  • Gets or sets the 1-based value of the month or quarter to filter in.

    If the [[type]] is Month, a Value of 1 indicates January, 2 indicates February, and so on. If Type is Quarter, a Value of 1 indicates Quarter 1, and so on.

    The 1-based value of the month or quarter to filter in.

    Throws

    [[ArgumentException]] [[type]] is Quarter and the value assigned is less than 1 or greater than 4 or Type is Month and the value assigned is less than 1 or greater than 12.

    See

    [[type]]

    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