Tableau Embedding API
    Preparing search index...

    Interface RelativeDateFilter

    An abstract base class for all of the filter types.

    interface RelativeDateFilter {
        anchorDate: DataValue;
        fieldId: string;
        fieldName: string;
        filterType: FilterType;
        periodType: PeriodType;
        rangeN: number;
        rangeType: DateRangeType;
        worksheetName: string;
        getAppliedWorksheetsAsync(): Promise<string[]>;
        getFieldAsync(): Promise<Field>;
        setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
    }

    Hierarchy (View Summary)

    Index

    Methods

    getAppliedWorksheetsAsync getFieldAsync setAppliedWorksheetsAsync

    Properties

    anchorDate fieldId fieldName filterType periodType rangeN rangeType worksheetName

    Methods

    • Returns Promise<string[]>

      the list of worksheet names that have the filter applied.

    • 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

    anchorDate: DataValue

    the anchor date of the filter

    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.

    periodType: PeriodType

    The date period of the filter.

    rangeN: number

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

    rangeType: DateRangeType

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

    worksheetName: string

    The parent worksheet.

    Settings

    Member Visibility

    On This Page

    Methods
    Properties