Represents a filter which can filter date cells based on dates relative to the when the filter was applied.

The RelativeDateRangeFilter allows you to filter in dates which are in the previous, current, or next time period relative to the date when the filter was applied. The time periods available are day, week, month, quarter, year. So when using the previous filter type with a day duration, a 'yesterday' filter is created. Or when using a current filter type with a year duration, a 'this year' filter is created. However, these filters compare the data against the date when the filter was created. So a 'this year' filter created in 1999 will filter in all cells containing dates in 1999, even if the workbook is opened in 2012.

See

  • [[WorksheetTableColumn.filter]]
  • [[WorksheetTableColumn.applyRelativeDateRangeFilter]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get duration(): RelativeDateRangeDuration
  • Gets or sets the duration of the full range of accepted dates.

    Throws

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

    See

    [[offset]]

    Returns RelativeDateRangeDuration

  • set duration(a): void
  • Parameters

    Returns void

  • get end(): Date
  • Gets the exclusive end date of the filtered in date range.

    See

    [[start]]

    Returns Date

  • get offset(): RelativeDateRangeOffset
  • Gets or sets the offset of relative filter (previous, current, or next).

    Type combined with [[duration]] determines the relative date range to filter.

    Throws

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

    See

    [[duration]]

    Returns RelativeDateRangeOffset

  • set offset(a): void
  • Parameters

    Returns void

  • get start(): Date
  • Gets the inclusive start date of the filtered in date range.

    See

    [[end]]

    Returns Date

Methods

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • 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