Contains filtering related functionality. This object is created when the document is loaded. To get an instance of this object use the Document.filtering property.

3.1

interface Filtering {
    getActiveFilteringScheme(callback: OnGetFilteringScheme): void;
    getAllModifiedFilterColumns(
        includedFilterSettings: includedFilterSettings,
        callback: OnGetFilterColumns,
    ): void;
    getFilterColumn(
        filteringSchemeName: string,
        dataTableName: string,
        dataColumnName: string,
        includedFilterSettings: includedFilterSettings,
        callback: OnGetFilterColumn,
    ): void;
    getFilteringScheme(
        filteringSchemeName: string,
        callback: OnGetFilteringScheme,
    ): void;
    getFilteringSchemes(callback: OnGetFilteringSchemes): void;
    getModifiedFilterColumns(
        filteringSchemeName: string,
        includedFilterSettings: includedFilterSettings,
        callback: OnGetFilterColumns,
    ): void;
    resetAllFilters(): void;
    resetAllFiltersOnActivePage(): void;
    setFilter(
        filterColumn: FilterColumn,
        filteringOperation: filteringOperation,
    ): void;
    setFilters(
        filterColumns: FilterColumn[],
        filteringOperation: filteringOperation,
    ): void;
}

Methods

  • Get the information about all filter columns that do not have the default value selected in all filtering schemas.

    Parameters

    • includedFilterSettings: includedFilterSettings

      How the filter values should be returned. Note, for some filter types like the checkbox hierarchy filter, the value can contain large amounts of data. Checkbox hierarchy filters that loads data on request will return an empty list.

    • callback: OnGetFilterColumns

      The callback function.

    Returns void

  • Get the information about a filter column.

    Parameters

    • filteringSchemeName: string

      The filtering scheme name where the filter column is located.

    • dataTableName: string

      The data table name in which the filter column is located.

    • dataColumnName: string

      The name of the filter column.

    • includedFilterSettings: includedFilterSettings

      How the filter values should be returned. Note, for some filter types like the checkbox hierarchy filter, the value can contain large amounts of data. Checkbox hierarchy filters that loads data on request will return an empty list.

    • callback: OnGetFilterColumn

      The callback function.

    Returns void

  • Get the information about all filter columns that do not have the default value selected.

    Parameters

    • filteringSchemeName: string

      The filtering scheme name where the filter columns are located.

    • includedFilterSettings: includedFilterSettings

      How the filter values should be returned. Note, for some filter types like the checkbox hierarchy filter, the value can contain large amounts of data. Checkbox hierarchy filters that loads data on request will return an empty list.

    • callback: OnGetFilterColumns

      The callback function.

    Returns void

  • Resets all filters to the default values.

    Returns void

  • Resets all filters on active page to their default values.

    Returns void

    5.0

  • Set the value(s) of a filter column.

    Parameters

    Returns void

    3.1

  • Apply new values to a list of filters.

    Parameters

    Returns void

MMNEPVFCICPMFPCPTTAAATR