dsl-builder/dist/opensearch_query/filters/meta_filter.d.ts

OpenSearch Query Builder - Extract from OpenSearch Dashboards

export declare enum FilterStateStore {
    APP_STATE = "appState",
    GLOBAL_STATE = "globalState"
}
export type FilterState = {
    store: FilterStateStore;
};
type FilterFormatterFunction = (value: any) => string;
export interface FilterValueFormatter {
    convert: FilterFormatterFunction;
    getConverterFor: (type: string) => FilterFormatterFunction;
}
export type FilterMeta = {
    alias: string | null;
    disabled: boolean;
    negate: boolean;
    controlledBy?: string;
    index?: string;
    type?: string;
    key?: string;
    params?: any;
    value?: string;
};
export type Filter = {
    $state?: FilterState;
    meta: FilterMeta;
    query?: any;
};
export interface LatLon {
    lat: number;
    lon: number;
}
export declare const buildEmptyFilter: (isPinned: boolean, index?: string) => Filter;
export declare const isFilterPinned: (filter: Filter) => boolean | undefined;
export declare const toggleFilterDisabled: (filter: Filter) => {
    meta: {
        disabled: boolean;
        alias: string | null;
        negate: boolean;
        controlledBy?: string | undefined;
        index?: string | undefined;
        type?: string | undefined;
        key?: string | undefined;
        params?: any;
        value?: string | undefined;
    };
    $state?: FilterState | undefined;
    query?: any;
};
export declare const toggleFilterNegated: (filter: 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 | undefined;
    };
    $state?: FilterState | undefined;
    query?: any;
};
export declare const toggleFilterPinned: (filter: Filter) => {
    $state: {
        store: FilterStateStore;
    };
    meta: FilterMeta;
    query?: any;
};
export declare const enableFilter: (filter: Filter) => Filter;
export declare const disableFilter: (filter: Filter) => Filter;
export declare const pinFilter: (filter: Filter) => Filter;
export declare const unpinFilter: (filter: Filter) => Filter;
export declare const isFilter: (x: unknown) => x is Filter;
export declare const isFilters: (x: unknown) => x is Filter[];
export {};