@tanstack/table-core/build/lib/features/GlobalFaceting.d.ts

Headless UI for building powerful tables & datagrids for TS/JS.

import { RowModel } from '..';
import { RowData, TableFeature } from '../types';
export interface GlobalFacetingInstance<TData extends RowData> {
    _getGlobalFacetedMinMaxValues?: () => undefined | [number, number];
    _getGlobalFacetedRowModel?: () => RowModel<TData>;
    _getGlobalFacetedUniqueValues?: () => Map<any, number>;
    /**
     * Currently, this function returns the built-in `includesString` filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalautofilterfn)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)
     */
    getGlobalFacetedMinMaxValues: () => undefined | [number, number];
    /**
     * Returns the row model for the table after **global** filtering has been applied.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalfacetedrowmodel)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)
     */
    getGlobalFacetedRowModel: () => RowModel<TData>;
    /**
     * Returns the faceted unique values for the global filter.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalfaceteduniquevalues)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)
     */
    getGlobalFacetedUniqueValues: () => Map<any, number>;
}
export declare const GlobalFaceting: TableFeature;