kibana/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.esfilters.md
Liza Katz 28d0cf4485
Generate docs from data plugin (#56955)
* Add doc building for data plugin

* Added data server md file

* index file for suggestion component

* Clear out internal imports from public API

* Remove FunctionalComponent usage

* comment out working docs

* Added fixes following @octogonz feedback

* new docs

* Clean up

* Clean up 2

* fix jest

* rename docs script file

* update tasks

* tasks

* update docs
2020-03-10 11:34:06 +02:00

3.6 KiB

Home > kibana-plugin-plugins-data-public > esFilters

esFilters variable

Signature:

esFilters: {
    FilterLabel: typeof FilterLabel;
    FILTERS: typeof FILTERS;
    FilterStateStore: typeof FilterStateStore;
    buildEmptyFilter: (isPinned: boolean, index?: string | undefined) => import("../common").Filter;
    buildPhrasesFilter: (field: import("../common").IFieldType, params: any[], indexPattern: import("../common").IIndexPattern) => import("../common").PhrasesFilter;
    buildExistsFilter: (field: import("../common").IFieldType, indexPattern: import("../common").IIndexPattern) => import("../common").ExistsFilter;
    buildPhraseFilter: (field: import("../common").IFieldType, value: any, indexPattern: import("../common").IIndexPattern) => import("../common").PhraseFilter;
    buildQueryFilter: (query: any, index: string, alias: string) => import("../common").QueryStringFilter;
    buildRangeFilter: (field: import("../common").IFieldType, params: import("../common").RangeFilterParams, indexPattern: import("../common").IIndexPattern, formattedValue?: string | undefined) => import("../common").RangeFilter;
    isPhraseFilter: (filter: any) => filter is import("../common").PhraseFilter;
    isExistsFilter: (filter: any) => filter is import("../common").ExistsFilter;
    isPhrasesFilter: (filter: any) => filter is import("../common").PhrasesFilter;
    isRangeFilter: (filter: any) => filter is import("../common").RangeFilter;
    isMatchAllFilter: (filter: any) => filter is import("../common").MatchAllFilter;
    isMissingFilter: (filter: any) => filter is import("../common").MissingFilter;
    isQueryStringFilter: (filter: any) => filter is import("../common").QueryStringFilter;
    isFilterPinned: (filter: import("../common").Filter) => boolean | undefined;
    toggleFilterNegated: (filter: import("../common").Filter) => {
        meta: {
            negate: boolean;
            alias: string | null;
            disabled: boolean;
            controlledBy?: string | undefined;
            index?: string | undefined;
            type?: string | undefined;
            key?: string | undefined;
            params?: any;
            value?: string | ((formatter?: import("../common").FilterValueFormatter | undefined) => string) | undefined;
        };
        $state?: import("../common").FilterState | undefined;
        query?: any;
    };
    disableFilter: (filter: import("../common").Filter) => import("../common").Filter;
    getPhraseFilterField: (filter: import("../common").PhraseFilter) => string;
    getPhraseFilterValue: (filter: import("../common").PhraseFilter) => string | number | boolean;
    getDisplayValueFromFilter: typeof getDisplayValueFromFilter;
    compareFilters: (first: import("../common").Filter | import("../common").Filter[], second: import("../common").Filter | import("../common").Filter[], comparatorOptions?: import("./query/filter_manager/lib/compare_filters").FilterCompareOptions) => boolean;
    COMPARE_ALL_OPTIONS: import("./query/filter_manager/lib/compare_filters").FilterCompareOptions;
    generateFilters: typeof generateFilters;
    onlyDisabledFiltersChanged: (newFilters?: import("../common").Filter[] | undefined, oldFilters?: import("../common").Filter[] | undefined) => boolean;
    changeTimeFilter: typeof changeTimeFilter;
    mapAndFlattenFilters: (filters: import("../common").Filter[]) => import("../common").Filter[];
    extractTimeFilter: typeof extractTimeFilter;
}