Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RelativeDateFilter

Hierarchy

Index

Properties

Methods

Properties

anchorDate

anchorDate: DataValue
returns

the anchor date of the filter

fieldId

fieldId: string
returns

The id of the field being filtered.

fieldName

fieldName: string
returns

The name of the field being filtered. Note that this is the caption as shown in the UI, and not the actual database field name.

filterType

filterType: FilterType
returns

The type of the filter.

periodType

periodType: PeriodType
returns

The date period of the filter.

rangeN

rangeN: number
returns

When getRange returns LASTN or NEXTN, this is the N value (how many years, months, etc.).

rangeType

rangeType: DateRangeType
returns

The range of the date filter (years, months, etc.).

worksheetName

worksheetName: string
returns

The parent worksheet.

Methods

getAppliedWorksheetsAsync

  • getAppliedWorksheetsAsync(): Promise<Array<string>>

  • Returns Promise<Array<string>>

    the list of worksheet names that have the filter applied.

getFieldAsync

  • getFieldAsync(): Promise<Field>

  • Returns Promise<Field>

    a promise containing the field for the filter.

setAppliedWorksheetsAsync

  • setAppliedWorksheetsAsync(applyToWorksheets: Array<string>): Promise<Array<string>>

  • Applies the filter to the specified list of worksheets. If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.

    Parameters

    • applyToWorksheets: Array<string>

      list of worksheets to apply the filter on

    Returns Promise<Array<string>>

    the list of worksheet names that have the filter applied