Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RangeFilter

A Range Filter

Hierarchy

Index

Properties

Methods

Properties

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.

includeNullValues

includeNullValues: boolean
returns

True if null values are included in the filter, false otherwise.

maxValue

maxValue: DataValue
returns

Maximum value, inclusive, applied to the filter.

minValue

minValue: DataValue
returns

Minimum value, inclusive, applied to the filter.

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.

getDomainAsync

  • Parameters

    Returns Promise<RangeDomain>

    a promise containing the domain for the range filter

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