Tableau Embedding API
    Preparing search index...

    Interface RangeFilter

    A Range Filter

    interface RangeFilter {
        fieldId: string;
        fieldName: string;
        filterType: FilterType;
        includeNullValues: boolean;
        maxValue: DataValue;
        minValue: DataValue;
        worksheetName: string;
        getAppliedWorksheetsAsync(): Promise<string[]>;
        getDomainAsync(domainType?: FilterDomainType): Promise<RangeDomain>;
        getFieldAsync(): Promise<Field>;
        setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
    }

    Hierarchy (View Summary)

    Index

    Methods

    getAppliedWorksheetsAsync getDomainAsync getFieldAsync setAppliedWorksheetsAsync

    Properties

    fieldId fieldName filterType includeNullValues maxValue minValue worksheetName

    Methods

    • Returns Promise<string[]>

      the list of worksheet names that have the filter applied.

    • Parameters

      Returns Promise<RangeDomain>

      a promise containing the domain for the range filter

    • Returns Promise<Field>

      a promise containing the field for the filter.

    • 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: string[]

        list of worksheets to apply the filter on

      Returns Promise<string[]>

      the list of worksheet names that have the filter applied

    Properties

    fieldId: string

    The id of the field being filtered.

    fieldName: string

    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

    The type of the filter.

    includeNullValues: boolean

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

    maxValue: DataValue

    Maximum value, inclusive, applied to the filter.

    minValue: DataValue

    Minimum value, inclusive, applied to the filter.

    worksheetName: string

    The parent worksheet.

    Settings

    Member Visibility

    On This Page

    Methods
    Properties