Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Filter

An abstract base class for all of the filter types.

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.

worksheetName

worksheetName: string
returns

The parent worksheet.

Methods

getAppliedWorksheetsAsync

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

    1.9.0 and Tableau 2022.2

    Returns Promise<Array<string>>

    the list of worksheet names that have the filter applied.

getFieldAsync

  • getFieldAsync(): Promise<Field>
  • since

    1.5.0 Fixed to properly return the field. Also requires Tableau 2019.2+.

    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.

    since

    1.9.0 and Tableau 2022.2

    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