{ "id": "data.search", "client": { "classes": [ { "id": "def-public.SearchInterceptor", "type": "Class", "tags": [], "label": "SearchInterceptor", "description": [], "children": [ { "id": "def-public.SearchInterceptor.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "deps", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchInterceptorDeps", "text": "SearchInterceptorDeps" } ], "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 75, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L75" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 75, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L75" } }, { "id": "def-public.SearchInterceptor.getTimeoutMode", "type": "Function", "label": "getTimeoutMode", "signature": [ "() => ", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.TimeoutErrorMode", "text": "TimeoutErrorMode" } ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 91, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L91" } }, { "id": "def-public.SearchInterceptor.handleSearchError", "type": "Function", "label": "handleSearchError", "signature": [ "(e: ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.KibanaServerError", "text": "KibanaServerError" }, " | ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.AbortError", "text": "AbortError" }, ", timeoutSignal: AbortSignal, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Error" ], "description": [], "children": [ { "type": "CompoundType", "label": "e", "isRequired": true, "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.KibanaServerError", "text": "KibanaServerError" }, " | ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.AbortError", "text": "AbortError" } ], "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 100, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L100" } }, { "type": "Object", "label": "timeoutSignal", "isRequired": true, "signature": [ "AbortSignal" ], "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 101, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L101" } }, { "type": "Object", "label": "options", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 102, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L102" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 99, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L99" } }, { "id": "def-public.SearchInterceptor.search", "type": "Function", "label": "search", "signature": [ "(request: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchRequest", "text": "IKibanaSearchRequest" }, ", options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => ", "Observable", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, ">" ], "description": [ "\nSearches using the given `search` method. Overrides the `AbortSignal` with one that will abort\neither when the request times out, or when the original `AbortSignal` is aborted. Updates\n`pendingCount$` when the request is started/finalized.\n" ], "children": [ { "type": "Object", "label": "request", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchRequest", "text": "IKibanaSearchRequest" }, "" ], "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 247, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L247" } }, { "type": "Object", "label": "options", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 248, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L248" } } ], "tags": [ "options" ], "returnComment": [ "`Observable` emitting the search response or an error." ], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 246, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L246" } }, { "id": "def-public.SearchInterceptor.showError", "type": "Function", "label": "showError", "signature": [ "(e: Error) => void" ], "description": [], "children": [ { "type": "Object", "label": "e", "isRequired": true, "signature": [ "Error" ], "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 275, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L275" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 275, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L275" } } ], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 50, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L50" }, "initialIsOpen": false }, { "id": "def-public.SearchTimeoutError", "type": "Class", "tags": [], "label": "SearchTimeoutError", "description": [ "\nRequest Failure - When an entire multi request fails" ], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchTimeoutError", "text": "SearchTimeoutError" }, " extends ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.KbnError", "text": "KbnError" } ], "children": [ { "tags": [], "id": "def-public.SearchTimeoutError.mode", "type": "Enum", "label": "mode", "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/timeout_error.tsx#L26" }, "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.TimeoutErrorMode", "text": "TimeoutErrorMode" } ] }, { "id": "def-public.SearchTimeoutError.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "err", "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/timeout_error.tsx#L27" } }, { "type": "Enum", "label": "mode", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.TimeoutErrorMode", "text": "TimeoutErrorMode" } ], "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/timeout_error.tsx#L27" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/timeout_error.tsx#L27" } }, { "id": "def-public.SearchTimeoutError.getErrorMessage", "type": "Function", "label": "getErrorMessage", "signature": [ "(application: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", "section": "def-public.ApplicationStart", "text": "ApplicationStart" }, ") => JSX.Element" ], "description": [], "children": [ { "type": "Object", "label": "application", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", "section": "def-public.ApplicationStart", "text": "ApplicationStart" } ], "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", "lineNumber": 80, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/timeout_error.tsx#L80" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", "lineNumber": 80, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/timeout_error.tsx#L80" } } ], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/timeout_error.tsx#L25" }, "initialIsOpen": false }, { "id": "def-public.PainlessError", "type": "Class", "tags": [], "label": "PainlessError", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.PainlessError", "text": "PainlessError" }, " extends ", "EsError" ], "children": [ { "tags": [], "id": "def-public.PainlessError.painlessStack", "type": "string", "label": "painlessStack", "description": [], "source": { "path": "src/plugins/data/public/search/errors/painless_error.tsx", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/painless_error.tsx#L20" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.PainlessError.indexPattern", "type": "Object", "label": "indexPattern", "description": [], "source": { "path": "src/plugins/data/public/search/errors/painless_error.tsx", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/painless_error.tsx#L21" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined" ] }, { "id": "def-public.PainlessError.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "err", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.IEsError", "text": "IEsError" } ], "description": [], "source": { "path": "src/plugins/data/public/search/errors/painless_error.tsx", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/painless_error.tsx#L22" } }, { "type": "Object", "label": "indexPattern", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/data/public/search/errors/painless_error.tsx", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/painless_error.tsx#L22" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/public/search/errors/painless_error.tsx", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/painless_error.tsx#L22" } }, { "id": "def-public.PainlessError.getErrorMessage", "type": "Function", "label": "getErrorMessage", "signature": [ "(application: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", "section": "def-public.ApplicationStart", "text": "ApplicationStart" }, ") => JSX.Element" ], "description": [], "children": [ { "type": "Object", "label": "application", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", "section": "def-public.ApplicationStart", "text": "ApplicationStart" } ], "description": [], "source": { "path": "src/plugins/data/public/search/errors/painless_error.tsx", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/painless_error.tsx#L27" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/public/search/errors/painless_error.tsx", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/painless_error.tsx#L27" } } ], "source": { "path": "src/plugins/data/public/search/errors/painless_error.tsx", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/painless_error.tsx#L19" }, "initialIsOpen": false } ], "functions": [ { "id": "def-public.getEsPreference", "type": "Function", "label": "getEsPreference", "signature": [ "(uiSettings: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.IUiSettingsClient", "text": "IUiSettingsClient" }, ", sessionId: string) => any" ], "description": [], "children": [ { "type": "Object", "label": "uiSettings", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.IUiSettingsClient", "text": "IUiSettingsClient" } ], "description": [], "source": { "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/es_search/get_es_preference.ts#L14" } }, { "type": "string", "label": "sessionId", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/es_search/get_es_preference.ts#L14" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/es_search/get_es_preference.ts#L14" }, "initialIsOpen": false } ], "interfaces": [ { "id": "def-public.ISearchSetup", "type": "Interface", "label": "ISearchSetup", "description": [ "\nThe setup contract exposed by the Search plugin exposes the search strategy extension\npoint." ], "tags": [], "children": [ { "tags": [], "id": "def-public.ISearchSetup.aggs", "type": "Object", "label": "aggs", "description": [], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/types.ts#L29" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggsCommonSetup", "text": "AggsCommonSetup" } ] }, { "tags": [], "id": "def-public.ISearchSetup.usageCollector", "type": "Object", "label": "usageCollector", "description": [], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/types.ts#L30" }, "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchUsageCollector", "text": "SearchUsageCollector" }, " | undefined" ] }, { "tags": [], "id": "def-public.ISearchSetup.session", "type": "Object", "label": "session", "description": [ "\nCurrent session management\n{@link ISessionService}" ], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/types.ts#L35" }, "signature": [ "Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SessionService", "text": "SessionService" }, ", \"start\" | \"destroy\" | \"state$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" ] }, { "tags": [], "id": "def-public.ISearchSetup.sessionsClient", "type": "Object", "label": "sessionsClient", "description": [ "\nSearch sessions SO CRUD\n{@link ISessionsClient}" ], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 40, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/types.ts#L40" }, "signature": [ "Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SessionsClient", "text": "SessionsClient" }, ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"extend\">" ] } ], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/types.ts#L28" }, "initialIsOpen": false }, { "id": "def-public.ISearchStart", "type": "Interface", "label": "ISearchStart", "description": [ "\nsearch service" ], "tags": [ "public" ], "children": [ { "tags": [], "id": "def-public.ISearchStart.aggs", "type": "Object", "label": "aggs", "description": [ "\nagg config sub service\n{@link AggsStart}\n" ], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 57, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/types.ts#L57" }, "signature": [ "Pick & Pick<{ types: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggTypesRegistryStart", "text": "AggTypesRegistryStart" }, "; }, \"types\"> & Pick<{ types: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggTypesRegistryStart", "text": "AggTypesRegistryStart" }, "; }, never>, \"calculateAutoTimeExpression\" | \"getDateMetaByDatatableColumn\" | \"datatableUtilities\" | \"createAggConfigs\" | \"types\">" ] }, { "tags": [], "id": "def-public.ISearchStart.search", "type": "Function", "label": "search", "description": [ "\nlow level search\n{@link ISearchGeneric}" ], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 62, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/types.ts#L62" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchGeneric", "text": "ISearchGeneric" } ] }, { "tags": [], "id": "def-public.ISearchStart.showError", "type": "Function", "label": "showError", "description": [], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 64, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/types.ts#L64" }, "signature": [ "(e: Error) => void" ] }, { "tags": [], "id": "def-public.ISearchStart.searchSource", "type": "Object", "label": "searchSource", "description": [ "\nhigh level search\n{@link ISearchStartSearchSource}" ], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 69, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/types.ts#L69" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchStartSearchSource", "text": "ISearchStartSearchSource" } ] }, { "tags": [], "id": "def-public.ISearchStart.session", "type": "Object", "label": "session", "description": [ "\nCurrent session management\n{@link ISessionService}" ], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 74, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/types.ts#L74" }, "signature": [ "Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SessionService", "text": "SessionService" }, ", \"start\" | \"destroy\" | \"state$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" ] }, { "tags": [], "id": "def-public.ISearchStart.sessionsClient", "type": "Object", "label": "sessionsClient", "description": [ "\nSearch sessions SO CRUD\n{@link ISessionsClient}" ], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 79, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/types.ts#L79" }, "signature": [ "Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SessionsClient", "text": "SessionsClient" }, ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"extend\">" ] } ], "source": { "path": "src/plugins/data/public/search/types.ts", "lineNumber": 51, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/types.ts#L51" }, "initialIsOpen": false }, { "id": "def-public.SearchInterceptorDeps", "type": "Interface", "label": "SearchInterceptorDeps", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SearchInterceptorDeps.bfetch", "type": "Object", "label": "bfetch", "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 41, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L41" }, "signature": [ { "pluginId": "bfetch", "scope": "public", "docId": "kibBfetchPluginApi", "section": "def-public.BfetchPublicContract", "text": "BfetchPublicContract" } ] }, { "tags": [], "id": "def-public.SearchInterceptorDeps.http", "type": "Object", "label": "http", "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 42, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L42" }, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpSetup", "text": "HttpSetup" } ] }, { "tags": [], "id": "def-public.SearchInterceptorDeps.uiSettings", "type": "Object", "label": "uiSettings", "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 43, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L43" }, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.IUiSettingsClient", "text": "IUiSettingsClient" } ] }, { "tags": [], "id": "def-public.SearchInterceptorDeps.startServices", "type": "Object", "label": "startServices", "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 44, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L44" }, "signature": [ "Promise<[", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreStart", "text": "CoreStart" }, ", any, unknown]>" ] }, { "tags": [], "id": "def-public.SearchInterceptorDeps.toasts", "type": "Object", "label": "toasts", "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 45, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L45" }, "signature": [ "Pick<", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.ToastsApi", "text": "ToastsApi" }, ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" ] }, { "tags": [], "id": "def-public.SearchInterceptorDeps.usageCollector", "type": "Object", "label": "usageCollector", "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 46, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L46" }, "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchUsageCollector", "text": "SearchUsageCollector" }, " | undefined" ] }, { "tags": [], "id": "def-public.SearchInterceptorDeps.session", "type": "Object", "label": "session", "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 47, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L47" }, "signature": [ "Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SessionService", "text": "SessionService" }, ", \"start\" | \"destroy\" | \"state$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" ] } ], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", "lineNumber": 40, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/search_interceptor.ts#L40" }, "initialIsOpen": false }, { "id": "def-public.SearchSessionInfoProvider", "type": "Interface", "label": "SearchSessionInfoProvider", "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchSessionInfoProvider", "text": "SearchSessionInfoProvider" }, "" ], "description": [ "\nProvide info about current search session to be stored in the Search Session saved object" ], "tags": [], "children": [ { "tags": [], "id": "def-public.SearchSessionInfoProvider.getName", "type": "Function", "label": "getName", "description": [ "\nUser-facing name of the session.\ne.g. will be displayed in saved Search Sessions management list" ], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", "lineNumber": 39, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/session/session_service.ts#L39" }, "signature": [ "() => Promise" ] }, { "tags": [], "id": "def-public.SearchSessionInfoProvider.getUrlGeneratorData", "type": "Function", "label": "getUrlGeneratorData", "description": [], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", "lineNumber": 40, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/session/session_service.ts#L40" }, "signature": [ "() => Promise<{ urlGeneratorId: ID; initialState: ", { "pluginId": "share", "scope": "public", "docId": "kibSharePluginApi", "section": "def-public.UrlGeneratorStateMapping", "text": "UrlGeneratorStateMapping" }, "[ID][\"State\"]; restoreState: ", { "pluginId": "share", "scope": "public", "docId": "kibSharePluginApi", "section": "def-public.UrlGeneratorStateMapping", "text": "UrlGeneratorStateMapping" }, "[ID][\"State\"]; }>" ] } ], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", "lineNumber": 34, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/session/session_service.ts#L34" }, "initialIsOpen": false } ], "enums": [ { "id": "def-public.SearchSessionState", "type": "Enum", "label": "SearchSessionState", "tags": [ "public" ], "description": [ "\nPossible state that current session can be in\n" ], "source": { "path": "src/plugins/data/public/search/session/search_session_state.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/session/search_session_state.ts#L19" }, "initialIsOpen": false }, { "id": "def-public.TimeoutErrorMode", "type": "Enum", "label": "TimeoutErrorMode", "tags": [], "description": [], "source": { "path": "src/plugins/data/public/search/errors/timeout_error.tsx", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/errors/timeout_error.tsx#L15" }, "initialIsOpen": false } ], "misc": [ { "id": "def-public.EsdslExpressionFunctionDefinition", "type": "Type", "label": "EsdslExpressionFunctionDefinition", "tags": [], "description": [], "source": { "path": "src/plugins/data/public/search/expressions/esdsl.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/expressions/esdsl.ts#L30" }, "signature": [ "ExpressionFunctionDefinition<\"esdsl\", ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, "> | null, Arguments, Output, ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", "SerializableState" ], "initialIsOpen": false }, { "id": "def-public.EsRawResponseExpressionTypeDefinition", "type": "Type", "label": "EsRawResponseExpressionTypeDefinition", "tags": [], "description": [], "source": { "path": "src/plugins/data/public/search/expressions/es_raw_response.ts", "lineNumber": 57, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/expressions/es_raw_response.ts#L57" }, "signature": [ "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.noSearchSessionStorageCapabilityMessage", "type": "string", "label": "noSearchSessionStorageCapabilityMessage", "description": [ "\nMessage to display in case storing\nsession session is disabled due to turned off capability" ], "source": { "path": "src/plugins/data/public/search/session/i18n.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/session/i18n.ts#L15" }, "initialIsOpen": false }, { "tags": [], "id": "def-public.SEARCH_SESSIONS_MANAGEMENT_ID", "type": "string", "label": "SEARCH_SESSIONS_MANAGEMENT_ID", "description": [], "source": { "path": "src/plugins/data/public/search/session/constants.ts", "lineNumber": 9, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/session/constants.ts#L9" }, "signature": [ "\"search_sessions\"" ], "initialIsOpen": false }, { "id": "def-public.ISessionService", "type": "Type", "label": "ISessionService", "tags": [], "description": [], "source": { "path": "src/plugins/data/public/search/session/session_service.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/session/session_service.ts#L25" }, "signature": [ "{ start: () => string; destroy: () => void; readonly state$: Observable; hasAccess: () => boolean; trackSearch: (searchDescriptor: TrackSearchDescriptor) => () => void; getSessionId: () => string | undefined; getSession$: () => Observable; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage: (searchSessionInfoProvider: SearchSessionInfoProvider, searchSessionIndicatorUiConfig?: SearchSessionIndicatorUiConfig | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => SearchSessionIndicatorUiConfig; }" ], "initialIsOpen": false }, { "id": "def-public.ISessionsClient", "type": "Type", "label": "ISessionsClient", "tags": [], "description": [], "source": { "path": "src/plugins/data/public/search/session/sessions_client.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/search/session/sessions_client.ts#L13" }, "signature": [ "{ get: (sessionId: string) => Promise>; delete: (sessionId: string) => Promise; create: ({ name, appId, urlGeneratorId, initialState, restoreState, sessionId, }: { name: string; appId: string; initialState: Record; restoreState: Record; urlGeneratorId: string; sessionId: string; }) => Promise>; find: (options: Pick) => Promise>; update: (sessionId: string, attributes: unknown) => Promise>; extend: (sessionId: string, expires: string) => Promise>; }" ], "initialIsOpen": false } ], "objects": [] }, "server": { "classes": [], "functions": [ { "id": "def-server.getDefaultSearchParams", "type": "Function", "label": "getDefaultSearchParams", "signature": [ "(uiSettingsClient: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.IUiSettingsClient", "text": "IUiSettingsClient" }, ") => Promise>>, \"max_concurrent_shard_requests\" | \"ignore_unavailable\" | \"track_total_hits\">>" ], "description": [], "children": [ { "type": "Object", "label": "uiSettingsClient", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.IUiSettingsClient", "text": "IUiSettingsClient" } ], "description": [], "source": { "path": "src/plugins/data/server/search/es_search/request_utils.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/es_search/request_utils.ts#L20" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/server/search/es_search/request_utils.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/es_search/request_utils.ts#L19" }, "initialIsOpen": false }, { "id": "def-server.getShardTimeout", "type": "Function", "label": "getShardTimeout", "signature": [ "(config: Readonly<{ kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly autocompleteTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", "ByteSizeValue", ") => boolean; isLessThan: (other: ", "ByteSizeValue", ") => boolean; isEqualTo: (other: ", "ByteSizeValue", ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>) => Pick<", "Search", "<", "RequestBody" ], "description": [], "children": [ { "type": "Object", "label": "config", "isRequired": true, "signature": [ "Readonly<{ kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly autocompleteTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", "ByteSizeValue", ") => boolean; isLessThan: (other: ", "ByteSizeValue", ") => boolean; isEqualTo: (other: ", "ByteSizeValue", ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>" ], "description": [], "source": { "path": "src/plugins/data/server/search/es_search/request_utils.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/es_search/request_utils.ts#L14" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/server/search/es_search/request_utils.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/es_search/request_utils.ts#L14" }, "initialIsOpen": false }, { "id": "def-server.usageProvider", "type": "Function", "label": "usageProvider", "signature": [ "(core: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreSetup", "text": "CoreSetup" }, ") => ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchUsage", "text": "SearchUsage" } ], "description": [], "children": [ { "type": "Object", "label": "core", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreSetup", "text": "CoreSetup" }, "" ], "description": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/collectors/usage.ts#L22" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/collectors/usage.ts#L22" }, "initialIsOpen": false }, { "id": "def-server.searchUsageObserver", "type": "Function", "label": "searchUsageObserver", "signature": [ "(logger: ", "Logger", ", usage: ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchUsage", "text": "SearchUsage" }, " | undefined) => { next(response: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchResponse", "text": "IEsSearchResponse" }, "): void; error(): void; }" ], "description": [ "\nRxjs observer for easily doing `tap(searchUsageObserver(logger, usage))` in an rxjs chain." ], "children": [ { "type": "Object", "label": "logger", "isRequired": true, "signature": [ "Logger" ], "description": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 64, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/collectors/usage.ts#L64" } }, { "type": "Object", "label": "usage", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchUsage", "text": "SearchUsage" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 64, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/collectors/usage.ts#L64" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 64, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/collectors/usage.ts#L64" }, "initialIsOpen": false } ], "interfaces": [ { "id": "def-server.ISearchStrategy", "type": "Interface", "label": "ISearchStrategy", "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.ISearchStrategy", "text": "ISearchStrategy" }, "" ], "description": [ "\nSearch strategy interface contains a search method that takes in a request and returns a promise\nthat resolves to a response." ], "tags": [], "children": [ { "tags": [], "id": "def-server.ISearchStrategy.search", "type": "Function", "label": "search", "description": [], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 75, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L75" }, "signature": [ "(request: SearchStrategyRequest, options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ", deps: ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchStrategyDependencies", "text": "SearchStrategyDependencies" }, ") => ", "Observable", "" ] }, { "tags": [], "id": "def-server.ISearchStrategy.cancel", "type": "Function", "label": "cancel", "description": [], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 80, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L80" }, "signature": [ "((id: string, options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ", deps: ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchStrategyDependencies", "text": "SearchStrategyDependencies" }, ") => Promise) | undefined" ] }, { "tags": [], "id": "def-server.ISearchStrategy.extend", "type": "Function", "label": "extend", "description": [], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 81, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L81" }, "signature": [ "((id: string, keepAlive: string, options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ", deps: ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchStrategyDependencies", "text": "SearchStrategyDependencies" }, ") => Promise) | undefined" ] } ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 71, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L71" }, "initialIsOpen": false }, { "id": "def-server.ISearchSetup", "type": "Interface", "label": "ISearchSetup", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.ISearchSetup.aggs", "type": "Object", "label": "aggs", "description": [], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 43, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L43" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggsCommonSetup", "text": "AggsCommonSetup" } ] }, { "tags": [], "id": "def-server.ISearchSetup.registerSearchStrategy", "type": "Function", "label": "registerSearchStrategy", "description": [ "\nExtension point exposed for other plugins to register their own search\nstrategies." ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 48, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L48" }, "signature": [ " = ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchRequest", "text": "IEsSearchRequest" }, ", SearchStrategyResponse extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " = ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchResponse", "text": "IEsSearchResponse" }, ">(name: string, strategy: ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.ISearchStrategy", "text": "ISearchStrategy" } ] }, { "tags": [], "id": "def-server.ISearchSetup.usage", "type": "Object", "label": "usage", "description": [ "\nUsed internally for telemetry" ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 59, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L59" }, "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchUsage", "text": "SearchUsage" }, " | undefined" ] } ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 42, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L42" }, "initialIsOpen": false }, { "id": "def-server.ISearchStart", "type": "Interface", "label": "ISearchStart", "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.ISearchStart", "text": "ISearchStart" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.ISearchStart.aggs", "type": "Object", "label": "aggs", "description": [], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 103, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L103" }, "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.AggsStart", "text": "AggsStart" } ] }, { "tags": [], "id": "def-server.ISearchStart.getSearchStrategy", "type": "Function", "label": "getSearchStrategy", "description": [ "\nGet other registered search strategies by name (or, by default, the Elasticsearch strategy).\nFor example, if a new strategy needs to use the already-registered ES search strategy, it can\nuse this function to accomplish that." ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 109, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L109" }, "signature": [ "(name?: string | undefined) => ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.ISearchStrategy", "text": "ISearchStrategy" }, "" ] }, { "tags": [], "id": "def-server.ISearchStart.asScoped", "type": "Function", "label": "asScoped", "description": [], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 112, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L112" }, "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") => ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.IScopedSearchClient", "text": "IScopedSearchClient" } ] }, { "tags": [], "id": "def-server.ISearchStart.searchSource", "type": "Object", "label": "searchSource", "description": [], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 113, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L113" }, "signature": [ "{ asScoped: (request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchStartSearchSource", "text": "ISearchStartSearchSource" }, ">; }" ] } ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 99, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L99" }, "initialIsOpen": false }, { "id": "def-server.SearchStrategyDependencies", "type": "Interface", "label": "SearchStrategyDependencies", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.SearchStrategyDependencies.savedObjectsClient", "type": "Object", "label": "savedObjectsClient", "description": [], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 36, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L36" }, "signature": [ "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" ] }, { "tags": [], "id": "def-server.SearchStrategyDependencies.esClient", "type": "Object", "label": "esClient", "description": [], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L37" }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.IScopedClusterClient", "text": "IScopedClusterClient" } ] }, { "tags": [], "id": "def-server.SearchStrategyDependencies.uiSettingsClient", "type": "Object", "label": "uiSettingsClient", "description": [], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L38" }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.IUiSettingsClient", "text": "IUiSettingsClient" } ] }, { "tags": [], "id": "def-server.SearchStrategyDependencies.searchSessionsClient", "type": "Object", "label": "searchSessionsClient", "description": [], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 39, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L39" }, "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.IScopedSearchSessionsClient", "text": "IScopedSearchSessionsClient" }, "" ] } ], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L35" }, "initialIsOpen": false }, { "id": "def-server.SearchUsage", "type": "Interface", "label": "SearchUsage", "description": [], "tags": [], "children": [ { "id": "def-server.SearchUsage.trackError", "type": "Function", "label": "trackError", "signature": [ "() => Promise" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/collectors/usage.ts#L18" } }, { "id": "def-server.SearchUsage.trackSuccess", "type": "Function", "label": "trackSuccess", "signature": [ "(duration: number) => Promise" ], "description": [], "children": [ { "type": "number", "label": "duration", "isRequired": true, "signature": [ "number" ], "description": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/collectors/usage.ts#L19" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/collectors/usage.ts#L19" } } ], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/collectors/usage.ts#L17" }, "initialIsOpen": false }, { "id": "def-server.ISearchSessionService", "type": "Interface", "label": "ISearchSessionService", "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.ISearchSessionService", "text": "ISearchSessionService" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.ISearchSessionService.asScopedProvider", "type": "Function", "label": "asScopedProvider", "description": [], "source": { "path": "src/plugins/data/server/search/session/types.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/session/types.ts#L37" }, "signature": [ "(core: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreStart", "text": "CoreStart" }, ") => (request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") => ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.IScopedSearchSessionsClient", "text": "IScopedSearchSessionsClient" }, "" ] } ], "source": { "path": "src/plugins/data/server/search/session/types.ts", "lineNumber": 36, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/session/types.ts#L36" }, "initialIsOpen": false } ], "enums": [], "misc": [ { "id": "def-server.SearchRequestHandlerContext", "type": "Type", "label": "SearchRequestHandlerContext", "tags": [], "description": [], "source": { "path": "src/plugins/data/server/search/types.ts", "lineNumber": 118, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/server/search/types.ts#L118" }, "signature": [ "IScopedSearchClient" ], "initialIsOpen": false } ], "objects": [] }, "common": { "classes": [ { "id": "def-common.AggConfig", "type": "Class", "tags": [], "label": "AggConfig", "description": [], "children": [ { "id": "def-common.AggConfig.ensureIds", "type": "Function", "label": "ensureIds", "signature": [ "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ".ensureIds" ], "description": [ "\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n" ], "children": [ { "type": "Array", "label": "list", "isRequired": true, "signature": [ "any[]" ], "description": [ "- a list of objects, objects can be anything really" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 63, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L63" } } ], "tags": [ "return" ], "returnComment": [ "- the list that was passed in" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 63, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L63" } }, { "id": "def-common.AggConfig.nextId", "type": "Function", "label": "nextId", "signature": [ "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ".nextId" ], "description": [ "\nCalculate the next id based on the ids in this list\n" ], "children": [ { "type": "Array", "label": "list", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 83, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L83" } } ], "tags": [ "return" ], "returnComment": [ "list - a list of objects with id properties" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 83, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L83" } }, { "tags": [], "id": "def-common.AggConfig.aggConfigs", "type": "Object", "label": "aggConfigs", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 92, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L92" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" } ] }, { "tags": [], "id": "def-common.AggConfig.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 93, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L93" } }, { "tags": [], "id": "def-common.AggConfig.enabled", "type": "boolean", "label": "enabled", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 94, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L94" } }, { "tags": [], "id": "def-common.AggConfig.params", "type": "Any", "label": "params", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 95, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L95" }, "signature": [ "any" ] }, { "tags": [], "id": "def-common.AggConfig.parent", "type": "Object", "label": "parent", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 96, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L96" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined" ] }, { "tags": [], "id": "def-common.AggConfig.brandNew", "type": "CompoundType", "label": "brandNew", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 97, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L97" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggConfig.schema", "type": "string", "label": "schema", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 98, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L98" }, "signature": [ "string | undefined" ] }, { "id": "def-common.AggConfig.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "aggConfigs", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 104, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L104" } }, { "type": "Object", "label": "opts", "isRequired": true, "signature": [ "Pick & Pick<{ type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 104, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L104" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 104, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L104" } }, { "id": "def-common.AggConfig.setParams", "type": "Function", "label": "setParams", "signature": [ "(from: any) => void" ], "description": [ "\nWrite the current values to this.params, filling in the defaults as we go\n" ], "children": [ { "type": "Any", "label": "from", "isRequired": true, "signature": [ "any" ], "description": [ "- optional object to read values from,\n used when initializing" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 134, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L134" } } ], "tags": [ "return" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 134, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L134" } }, { "id": "def-common.AggConfig.getParam", "type": "Function", "label": "getParam", "signature": [ "(key: string) => any" ], "description": [], "children": [ { "type": "string", "label": "key", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 171, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L171" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 171, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L171" } }, { "id": "def-common.AggConfig.write", "type": "Function", "label": "write", "signature": [ "(aggs?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined) => Record" ], "description": [], "children": [ { "type": "Object", "label": "aggs", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 175, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L175" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 175, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L175" } }, { "id": "def-common.AggConfig.isFilterable", "type": "Function", "label": "isFilterable", "signature": [ "() => boolean" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 179, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L179" } }, { "id": "def-common.AggConfig.createFilter", "type": "Function", "label": "createFilter", "signature": [ "(key: string, params?: {}) => any" ], "description": [], "children": [ { "type": "string", "label": "key", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 183, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L183" } }, { "type": "Object", "label": "params", "isRequired": true, "signature": [ "{}" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 183, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L183" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 183, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L183" } }, { "id": "def-common.AggConfig.onSearchRequestStart", "type": "Function", "label": "onSearchRequestStart", "signature": [ "(searchSource: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise | Promise" ], "description": [ "\n Hook for pre-flight logic, see AggType#onSearchRequestStart" ], "children": [ { "type": "Object", "label": "searchSource", "isRequired": true, "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 209, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L209" } }, { "type": "Object", "label": "options", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 209, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L209" } } ], "tags": [ "return" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 209, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L209" } }, { "id": "def-common.AggConfig.toDsl", "type": "Function", "label": "toDsl", "signature": [ "(aggConfigs?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined) => any" ], "description": [ "\nConvert this aggConfig to its dsl syntax.\n\nAdds params and adhoc subaggs to a pojo, then returns it\n" ], "children": [ { "type": "Object", "label": "aggConfigs", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined" ], "description": [ "- the config object to convert" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 230, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L230" } } ], "tags": [ "return" ], "returnComment": [ "- if the config has a dsl representation, it is\n returned, else undefined is returned" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 230, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L230" } }, { "id": "def-common.AggConfig.serialize", "type": "Function", "label": "serialize", "signature": [ "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; }" ], "description": [], "children": [], "tags": [], "returnComment": [ "Returns a serialized representation of an AggConfig." ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 263, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L263" } }, { "id": "def-common.AggConfig.toJSON", "type": "Function", "label": "toJSON", "signature": [ "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; }" ], "description": [], "children": [], "tags": [ "deprecated" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 294, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L294" } }, { "id": "def-common.AggConfig.toSerializedFieldFormat", "type": "Function", "label": "toSerializedFieldFormat", "signature": [ "() => {}" ], "description": [ "\nReturns a serialized field format for the field used in this agg.\nThis can be passed to fieldFormats.deserialize to get the field\nformat instance.\n" ], "children": [], "tags": [ "public" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 305, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L305" } }, { "id": "def-common.AggConfig.toExpressionAst", "type": "Function", "label": "toExpressionAst", "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined" ], "description": [], "children": [], "tags": [], "returnComment": [ "Returns an ExpressionAst representing the this agg type." ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 314, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L314" } }, { "id": "def-common.AggConfig.getAggParams", "type": "Function", "label": "getAggParams", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamType", "text": "AggParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">[]" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 369, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L369" } }, { "id": "def-common.AggConfig.getRequestAggs", "type": "Function", "label": "getRequestAggs", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 373, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L373" } }, { "id": "def-common.AggConfig.getResponseAggs", "type": "Function", "label": "getResponseAggs", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 377, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L377" } }, { "id": "def-common.AggConfig.getValue", "type": "Function", "label": "getValue", "signature": [ "(bucket: any) => any" ], "description": [], "children": [ { "type": "Any", "label": "bucket", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 381, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L381" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 381, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L381" } }, { "id": "def-common.AggConfig.getKey", "type": "Function", "label": "getKey", "signature": [ "(bucket: any, key?: string | undefined) => any" ], "description": [], "children": [ { "type": "Any", "label": "bucket", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 385, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L385" } }, { "type": "string", "label": "key", "isRequired": false, "signature": [ "string | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 385, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L385" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 385, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L385" } }, { "id": "def-common.AggConfig.getFieldDisplayName", "type": "Function", "label": "getFieldDisplayName", "signature": [ "() => any" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 393, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L393" } }, { "id": "def-common.AggConfig.getField", "type": "Function", "label": "getField", "signature": [ "() => any" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 399, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L399" } }, { "id": "def-common.AggConfig.getValueBucketPath", "type": "Function", "label": "getValueBucketPath", "signature": [ "() => string" ], "description": [ "\nReturns the bucket path containing the main value the agg will produce\n(e.g. for sum of bytes it will point to the sum, for median it will point\n to the 50 percentile in the percentile multi value bucket)" ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 408, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L408" } }, { "id": "def-common.AggConfig.makeLabel", "type": "Function", "label": "makeLabel", "signature": [ "(percentageMode?: boolean) => any" ], "description": [], "children": [ { "type": "boolean", "label": "percentageMode", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 412, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L412" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 412, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L412" } }, { "id": "def-common.AggConfig.getIndexPattern", "type": "Function", "label": "getIndexPattern", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" } ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 426, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L426" } }, { "id": "def-common.AggConfig.getTimeRange", "type": "Function", "label": "getTimeRange", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 430, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L430" } }, { "id": "def-common.AggConfig.fieldName", "type": "Function", "label": "fieldName", "signature": [ "() => any" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 434, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L434" } }, { "id": "def-common.AggConfig.fieldIsTimeField", "type": "Function", "label": "fieldIsTimeField", "signature": [ "() => boolean | \"\" | undefined" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 439, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L439" } }, { "id": "def-common.AggConfig.type", "type": "Object", "label": "type", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 446, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L446" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" } ] }, { "id": "def-common.AggConfig.type", "type": "Object", "label": "type", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 450, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L450" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" } ] }, { "id": "def-common.AggConfig.setType", "type": "Function", "label": "setType", "signature": [ "(type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, ") => void" ], "description": [], "children": [ { "type": "Object", "label": "type", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 480, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L480" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 480, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L480" } } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 55, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L55" }, "initialIsOpen": false }, { "id": "def-common.AggConfigs", "type": "Class", "tags": [], "label": "AggConfigs", "description": [], "children": [ { "tags": [], "id": "def-common.AggConfigs.indexPattern", "type": "Object", "label": "indexPattern", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 58, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L58" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" } ] }, { "tags": [], "id": "def-common.AggConfigs.timeRange", "type": "Object", "label": "timeRange", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 59, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L59" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ] }, { "tags": [], "id": "def-common.AggConfigs.aggs", "type": "Array", "label": "aggs", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 62, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L62" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ] }, { "id": "def-common.AggConfigs.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "indexPattern", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 65, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L65" } }, { "type": "Array", "label": "configStates", "isRequired": true, "signature": [ "Pick & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 66, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L66" } }, { "type": "Object", "label": "opts", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigsOptions", "text": "AggConfigsOptions" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 67, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L67" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 64, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L64" } }, { "id": "def-common.AggConfigs.setTimeRange", "type": "Function", "label": "setTimeRange", "signature": [ "(timeRange: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => void" ], "description": [], "children": [ { "type": "Object", "label": "timeRange", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 79, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L79" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 79, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L79" } }, { "id": "def-common.AggConfigs.clone", "type": "Function", "label": "clone", "signature": [ "({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" } ], "description": [], "children": [ { "type": "Object", "label": "{ enabledOnly = true }", "isRequired": true, "signature": [ "{ enabledOnly?: boolean | undefined; }" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 97, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L97" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 97, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L97" } }, { "id": "def-common.AggConfigs.createAggConfig", "type": "Function", "children": [ { "type": "Object", "label": "params", "isRequired": true, "signature": [ "Pick & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 111, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L111" } }, { "type": "Object", "label": "{ addToAggConfigs = true }", "isRequired": true, "signature": [ "{ addToAggConfigs?: boolean | undefined; }" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 112, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L112" } } ], "signature": [ "(params: Pick & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" } ], "description": [], "label": "createAggConfig", "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 110, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L110" }, "tags": [], "returnComment": [] }, { "id": "def-common.AggConfigs.jsonDataEquals", "type": "Function", "label": "jsonDataEquals", "signature": [ "(aggConfigs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]) => boolean" ], "description": [ "\nData-by-data comparison of this Aggregation\nIgnores the non-array indexes" ], "children": [ { "type": "Array", "label": "aggConfigs", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "description": [ "an AggConfigs instance" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 153, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L153" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 153, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L153" } }, { "id": "def-common.AggConfigs.toDsl", "type": "Function", "label": "toDsl", "signature": [ "(hierarchical?: boolean) => Record" ], "description": [], "children": [ { "type": "boolean", "label": "hierarchical", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 165, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L165" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 165, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L165" } }, { "id": "def-common.AggConfigs.getAll", "type": "Function", "label": "getAll", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 227, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L227" } }, { "id": "def-common.AggConfigs.byIndex", "type": "Function", "label": "byIndex", "signature": [ "(index: number) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "description": [], "children": [ { "type": "number", "label": "index", "isRequired": true, "signature": [ "number" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 231, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L231" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 231, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L231" } }, { "id": "def-common.AggConfigs.byId", "type": "Function", "label": "byId", "signature": [ "(id: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, " | undefined" ], "description": [], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 235, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L235" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 235, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L235" } }, { "id": "def-common.AggConfigs.byName", "type": "Function", "label": "byName", "signature": [ "(name: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "description": [], "children": [ { "type": "string", "label": "name", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 239, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L239" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 239, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L239" } }, { "id": "def-common.AggConfigs.byType", "type": "Function", "label": "byType", "signature": [ "(type: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "description": [], "children": [ { "type": "string", "label": "type", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 243, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L243" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 243, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L243" } }, { "id": "def-common.AggConfigs.byTypeName", "type": "Function", "label": "byTypeName", "signature": [ "(type: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "description": [], "children": [ { "type": "string", "label": "type", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 247, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L247" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 247, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L247" } }, { "id": "def-common.AggConfigs.bySchemaName", "type": "Function", "label": "bySchemaName", "signature": [ "(schema: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "description": [], "children": [ { "type": "string", "label": "schema", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 251, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L251" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 251, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L251" } }, { "id": "def-common.AggConfigs.getRequestAggs", "type": "Function", "label": "getRequestAggs", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 255, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L255" } }, { "id": "def-common.AggConfigs.getRequestAggById", "type": "Function", "label": "getRequestAggById", "signature": [ "(id: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, " | undefined" ], "description": [], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 269, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L269" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 269, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L269" } }, { "id": "def-common.AggConfigs.getResponseAggs", "type": "Function", "label": "getResponseAggs", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "description": [ "\nGets the AggConfigs (and possibly ResponseAggConfigs) that\nrepresent the values that will be produced when all aggs\nare run.\n\nWith multi-value metric aggs it is possible for a single agg\nrequest to result in multiple agg values, which is why the length\nof a vis' responseValuesAggs may be different than the vis' aggs\n" ], "children": [], "tags": [ "return" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 284, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L284" } }, { "id": "def-common.AggConfigs.getResponseAggById", "type": "Function", "label": "getResponseAggById", "signature": [ "(id: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, " | undefined" ], "description": [ "\nFind a response agg by it's id. This may be an agg in the aggConfigs, or one\ncreated specifically for a response value\n" ], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [ "- the id of the agg to find" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 298, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L298" } } ], "tags": [ "return" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 298, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L298" } }, { "id": "def-common.AggConfigs.onSearchRequestStart", "type": "Function", "label": "onSearchRequestStart", "signature": [ "(searchSource: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise<[unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]>" ], "description": [], "children": [ { "type": "Object", "label": "searchSource", "isRequired": true, "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 307, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L307" } }, { "type": "Object", "label": "options", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 307, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L307" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 307, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L307" } } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 57, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L57" }, "initialIsOpen": false }, { "id": "def-common.AggType", "type": "Class", "tags": [], "label": "AggType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggType", "text": "AggType" }, "" ], "children": [ { "tags": [ "property", "type" ], "id": "def-common.AggType.name", "type": "string", "label": "name", "description": [ "\nthe unique, unchanging, name that we have assigned this aggType\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 70, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L70" } }, { "tags": [], "id": "def-common.AggType.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 72, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L72" } }, { "tags": [], "id": "def-common.AggType.subtype", "type": "string", "label": "subtype", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 73, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L73" }, "signature": [ "string | undefined" ] }, { "tags": [ "property", "type" ], "id": "def-common.AggType.dslName", "type": "string", "label": "dslName", "description": [ "\nthe name of the elasticsearch aggregation that this aggType represents. Usually just this.name\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 80, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L80" } }, { "tags": [ "property", "type" ], "id": "def-common.AggType.expressionName", "type": "string", "label": "expressionName", "description": [ "\nthe name of the expression function that this aggType represents.\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 87, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L87" } }, { "tags": [ "property", "type" ], "id": "def-common.AggType.title", "type": "string", "label": "title", "description": [ "\nthe user friendly name that will be shown in the ui for this aggType\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 94, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L94" } }, { "tags": [], "id": "def-common.AggType.valueType", "type": "CompoundType", "label": "valueType", "description": [ "\nThe type the values produced by this agg will have in the final data table.\nIf not specified, the type of the field is used." ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 99, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L99" }, "signature": [ "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" ] }, { "tags": [ "method" ], "id": "def-common.AggType.makeLabel", "type": "Function", "label": "makeLabel", "description": [ "\na function that will be called when this aggType is assigned to\nan aggConfig, and that aggConfig is being rendered (in a form, chart, etc.).\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 108, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L108" }, "signature": [ "((aggConfig: TAggConfig) => string) | (() => string)" ] }, { "tags": [ "property", "type" ], "id": "def-common.AggType.ordered", "type": "Any", "label": "ordered", "description": [ "\nDescribes if this aggType creates data that is ordered, and if that ordered data\nis some sort of time series.\n\nIf the aggType does not create ordered data, set this to something \"falsy\".\n\nIf this does create orderedData, then the value should be an object.\n\nIf the orderdata is some sort of time series, `this.ordered` should be an object\nwith the property `date: true`\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 123, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L123" }, "signature": [ "any" ] }, { "tags": [ "type" ], "id": "def-common.AggType.hasNoDsl", "type": "boolean", "label": "hasNoDsl", "description": [ "\nFlag that prevents this aggregation from being included in the dsl. This is only\nused by the count aggregation (currently) since it doesn't really exist and it's output\nis available on every bucket.\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 131, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L131" } }, { "tags": [], "id": "def-common.AggType.createFilter", "type": "Function", "label": "createFilter", "description": [ "\nThe method to create a filter representation of the bucket" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 138, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L138" }, "signature": [ "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" ] }, { "tags": [ "property", "type" ], "id": "def-common.AggType.params", "type": "Array", "label": "params", "description": [ "\nAn instance of {{#crossLink \"AggParams\"}}{{/crossLink}}.\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 145, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L145" }, "signature": [ "TParam[]" ] }, { "tags": [ "method" ], "id": "def-common.AggType.getRequestAggs", "type": "Function", "label": "getRequestAggs", "description": [ "\nDesigned for multi-value metric aggs, this method can return a\nset of AggConfigs that should replace this aggConfig in requests\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 155, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L155" }, "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" ] }, { "tags": [ "method" ], "id": "def-common.AggType.getResponseAggs", "type": "Function", "label": "getResponseAggs", "description": [ "\nDesigned for multi-value metric aggs, this method can return a\nset of AggConfigs that should replace this aggConfig in result sets\nthat walk the AggConfig set.\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 166, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L166" }, "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" ] }, { "tags": [], "id": "def-common.AggType.decorateAggConfig", "type": "Function", "label": "decorateAggConfig", "description": [ "\nA function that will be called each time an aggConfig of this type\nis created, giving the agg type a chance to modify the agg config" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 171, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L171" }, "signature": [ "() => any" ] }, { "tags": [ "return" ], "id": "def-common.AggType.postFlightRequest", "type": "Function", "label": "postFlightRequest", "description": [ "\nA function that needs to be called after the main request has been made\nand should return an updated response" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 184, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L184" }, "signature": [ "(resp: any, aggConfigs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, ", aggConfig: TAggConfig, searchSource: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, inspectorRequestAdapter?: ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, " | undefined, abortSignal?: AbortSignal | undefined, searchSessionId?: string | undefined) => Promise" ] }, { "tags": [ "return" ], "id": "def-common.AggType.getSerializedFormat", "type": "Function", "label": "getSerializedFormat", "description": [ "\nGet the serialized format for the values produced by this agg type,\noverridden by several metrics that always output a simple number.\nYou can pass this output to fieldFormatters.deserialize to get\nthe formatter instance.\n" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 202, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L202" }, "signature": [ "(agg: TAggConfig) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.SerializedFieldFormat", "text": "SerializedFieldFormat" }, ">" ] }, { "tags": [], "id": "def-common.AggType.getValue", "type": "Function", "label": "getValue", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 204, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L204" }, "signature": [ "(agg: TAggConfig, bucket: any) => any" ] }, { "tags": [], "id": "def-common.AggType.getKey", "type": "Function", "label": "getKey", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 206, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L206" }, "signature": [ "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" ] }, { "id": "def-common.AggType.paramByName", "type": "Function", "children": [ { "type": "string", "label": "name", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 208, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L208" } } ], "signature": [ "(name: string) => TParam | undefined" ], "description": [], "label": "paramByName", "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 208, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L208" }, "tags": [], "returnComment": [] }, { "id": "def-common.AggType.getValueBucketPath", "type": "Function", "children": [ { "type": "Uncategorized", "label": "agg", "isRequired": true, "signature": [ "TAggConfig" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 212, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L212" } } ], "signature": [ "(agg: TAggConfig) => string" ], "description": [], "label": "getValueBucketPath", "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 212, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L212" }, "tags": [], "returnComment": [] }, { "id": "def-common.AggType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [ "\nGeneric AggType Constructor\n\nUsed to create the values exposed by the agg_types module.\n" ], "children": [ { "type": "Object", "label": "config", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggTypeConfig", "text": "AggTypeConfig" }, ">" ], "description": [ "- used to set the properties of the AggType" ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 225, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L225" } } ], "tags": [ "class", "private" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 225, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L225" } } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 60, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L60" }, "initialIsOpen": false }, { "id": "def-common.AggTypesRegistry", "type": "Class", "tags": [], "label": "AggTypesRegistry", "description": [], "children": [ { "id": "def-common.AggTypesRegistry.setup", "type": "Function", "children": [], "signature": [ "() => { registerBucket: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, ">(name: N, type: T) => void; registerMetric: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, ">(name: N, type: T) => void; }" ], "description": [], "label": "setup", "source": { "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_types_registry.ts#L31" }, "tags": [], "returnComment": [] }, { "id": "def-common.AggTypesRegistry.start", "type": "Function", "children": [], "signature": [ "() => { get: (name: string) => any; getAll: () => { buckets: any[]; metrics: any[]; }; }" ], "description": [], "label": "start", "source": { "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", "lineNumber": 60, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_types_registry.ts#L60" }, "tags": [], "returnComment": [] } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_types_registry.ts#L27" }, "initialIsOpen": false }, { "id": "def-common.AggsCommonService", "type": "Class", "tags": [], "label": "AggsCommonService", "description": [ "\nThe aggs service provides a means of modeling and manipulating the various\nElasticsearch aggregations supported by Kibana, providing the ability to\noutput the correct DSL when you are ready to send your request to ES." ], "children": [ { "id": "def-common.AggsCommonService.setup", "type": "Function", "label": "setup", "signature": [ "({ registerFunction }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggsCommonSetupDependencies", "text": "AggsCommonSetupDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggsCommonSetup", "text": "AggsCommonSetup" } ], "description": [], "children": [ { "type": "Object", "label": "{ registerFunction }", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggsCommonSetupDependencies", "text": "AggsCommonSetupDependencies" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/aggs_service.ts", "lineNumber": 56, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/aggs_service.ts#L56" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/aggs_service.ts", "lineNumber": 56, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/aggs_service.ts#L56" } }, { "id": "def-common.AggsCommonService.start", "type": "Function", "label": "start", "signature": [ "({ getConfig, getIndexPattern, isDefaultTimezone, }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggsCommonStartDependencies", "text": "AggsCommonStartDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggsCommonStart", "text": "AggsCommonStart" } ], "description": [], "children": [ { "type": "Object", "label": "{\n getConfig,\n getIndexPattern,\n isDefaultTimezone,\n }", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggsCommonStartDependencies", "text": "AggsCommonStartDependencies" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/aggs_service.ts", "lineNumber": 73, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/aggs_service.ts#L73" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/aggs_service.ts", "lineNumber": 73, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/aggs_service.ts#L73" } } ], "source": { "path": "src/plugins/data/common/search/aggs/aggs_service.ts", "lineNumber": 53, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/aggs_service.ts#L53" }, "initialIsOpen": false }, { "id": "def-common.BucketAggType", "type": "Class", "tags": [], "label": "BucketAggType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggType", "text": "AggType" }, ">" ], "children": [ { "tags": [], "id": "def-common.BucketAggType.getKey", "type": "Function", "label": "getKey", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L35" }, "signature": [ "(bucket: any, key: any, agg: TBucketAggConfig) => any" ] }, { "tags": [], "id": "def-common.BucketAggType.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 36, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L36" } }, { "id": "def-common.BucketAggType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "config", "isRequired": true, "signature": [ "BucketAggTypeConfig" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L38" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L38" } } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L31" }, "initialIsOpen": false }, { "id": "def-common.CidrMask", "type": "Class", "tags": [], "label": "CidrMask", "description": [], "children": [ { "tags": [], "id": "def-common.CidrMask.initialAddress", "type": "Object", "label": "initialAddress", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L18" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.Ipv4Address", "text": "Ipv4Address" } ] }, { "tags": [], "id": "def-common.CidrMask.prefixLength", "type": "number", "label": "prefixLength", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L19" } }, { "id": "def-common.CidrMask.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "string", "label": "mask", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L21" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L21" } }, { "id": "def-common.CidrMask.getRange", "type": "Function", "label": "getRange", "signature": [ "() => { from: string; to: string; }" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L33" } }, { "id": "def-common.CidrMask.toString", "type": "Function", "label": "toString", "signature": [ "() => string" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "lineNumber": 44, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L44" } } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L17" }, "initialIsOpen": false }, { "id": "def-common.MetricAggType", "type": "Class", "tags": [], "label": "MetricAggType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggType", "text": "AggType" }, ">" ], "children": [ { "tags": [], "id": "def-common.MetricAggType.subtype", "type": "string", "label": "subtype", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 41, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L41" } }, { "tags": [], "id": "def-common.MetricAggType.isScalable", "type": "Function", "label": "isScalable", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 42, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L42" }, "signature": [ "() => boolean" ] }, { "tags": [], "id": "def-common.MetricAggType.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 43, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L43" } }, { "id": "def-common.MetricAggType.getKey", "type": "Function", "children": [], "signature": [ "() => void" ], "description": [], "label": "getKey", "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 45, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L45" }, "tags": [], "returnComment": [] }, { "id": "def-common.MetricAggType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "config", "isRequired": true, "signature": [ "MetricAggTypeConfig" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 47, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L47" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 47, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L47" } } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L37" }, "initialIsOpen": false }, { "id": "def-common.AggParamType", "type": "Class", "tags": [], "label": "AggParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamType", "text": "AggParamType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "" ], "children": [ { "tags": [], "id": "def-common.AggParamType.makeAgg", "type": "Function", "label": "makeAgg", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/agg.ts#L15" }, "signature": [ "(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" ] }, { "tags": [], "id": "def-common.AggParamType.allowedAggs", "type": "Array", "label": "allowedAggs", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/agg.ts#L16" }, "signature": [ "string[]" ] }, { "id": "def-common.AggParamType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "config", "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/agg.ts#L18" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/agg.ts#L18" } } ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/agg.ts#L12" }, "initialIsOpen": false }, { "id": "def-common.BaseParamType", "type": "Class", "tags": [], "label": "BaseParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "" ], "children": [ { "tags": [], "id": "def-common.BaseParamType.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L15" } }, { "tags": [], "id": "def-common.BaseParamType.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L16" } }, { "tags": [], "id": "def-common.BaseParamType.displayName", "type": "string", "label": "displayName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L17" } }, { "tags": [], "id": "def-common.BaseParamType.required", "type": "boolean", "label": "required", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L18" } }, { "tags": [], "id": "def-common.BaseParamType.advanced", "type": "boolean", "label": "advanced", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L19" } }, { "tags": [], "id": "def-common.BaseParamType.default", "type": "Any", "label": "default", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L20" }, "signature": [ "any" ] }, { "tags": [], "id": "def-common.BaseParamType.write", "type": "Function", "label": "write", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L21" }, "signature": [ "(aggConfig: TAggConfig, output: Record, aggConfigs?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined, locals?: Record | undefined) => void" ] }, { "tags": [], "id": "def-common.BaseParamType.serialize", "type": "Function", "label": "serialize", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L27" }, "signature": [ "(value: any, aggConfig?: TAggConfig | undefined) => any" ] }, { "tags": [], "id": "def-common.BaseParamType.deserialize", "type": "Function", "label": "deserialize", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L28" }, "signature": [ "(value: any, aggConfig?: TAggConfig | undefined) => any" ] }, { "tags": [], "id": "def-common.BaseParamType.toExpressionAst", "type": "Function", "label": "toExpressionAst", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L29" }, "signature": [ "((value: any) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined) | undefined" ] }, { "tags": [], "id": "def-common.BaseParamType.options", "type": "Array", "label": "options", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L30" }, "signature": [ "any[]" ] }, { "tags": [], "id": "def-common.BaseParamType.valueType", "type": "Any", "label": "valueType", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L31" }, "signature": [ "any" ] }, { "tags": [], "id": "def-common.BaseParamType.modifyAggConfigOnSearchRequestStart", "type": "Function", "label": "modifyAggConfigOnSearchRequestStart", "description": [ "\n A function that will be called before an aggConfig is serialized and sent to ES.\n Allows aggConfig to retrieve values needed for serialization\n Example usage: an aggregation needs to know the min/max of a field to determine an appropriate interval\n" ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 45, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L45" }, "signature": [ "(aggConfig: TAggConfig, searchSource?: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => void" ] }, { "id": "def-common.BaseParamType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "config", "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 51, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L51" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 51, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L51" } } ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/base.ts#L14" }, "initialIsOpen": false }, { "id": "def-common.FieldParamType", "type": "Class", "tags": [], "label": "FieldParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FieldParamType", "text": "FieldParamType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ], "children": [ { "tags": [], "id": "def-common.FieldParamType.required", "type": "boolean", "label": "required", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/field.ts#L24" } }, { "tags": [], "id": "def-common.FieldParamType.scriptable", "type": "boolean", "label": "scriptable", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/field.ts#L25" } }, { "tags": [], "id": "def-common.FieldParamType.filterFieldTypes", "type": "CompoundType", "label": "filterFieldTypes", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/field.ts#L26" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FieldTypes", "text": "FieldTypes" } ] }, { "tags": [], "id": "def-common.FieldParamType.onlyAggregatable", "type": "boolean", "label": "onlyAggregatable", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/field.ts#L27" } }, { "id": "def-common.FieldParamType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "config", "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/field.ts#L29" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/field.ts#L29" } }, { "id": "def-common.FieldParamType.getAvailableFields", "type": "Function", "children": [ { "type": "Object", "label": "aggConfig", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 100, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/field.ts#L100" } } ], "signature": [ "(aggConfig: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPatternField", "text": "IndexPatternField" }, "[]" ], "description": [ "\nfilter the fields to the available ones" ], "label": "getAvailableFields", "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 100, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/field.ts#L100" }, "tags": [], "returnComment": [] } ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/field.ts#L23" }, "initialIsOpen": false }, { "id": "def-common.JsonParamType", "type": "Class", "tags": [], "label": "JsonParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.JsonParamType", "text": "JsonParamType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ], "children": [ { "id": "def-common.JsonParamType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "config", "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/json.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/json.ts#L15" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/json.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/json.ts#L15" } } ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/json.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/json.ts#L14" }, "initialIsOpen": false }, { "id": "def-common.OptionedParamType", "type": "Class", "tags": [], "label": "OptionedParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.OptionedParamType", "text": "OptionedParamType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ], "children": [ { "tags": [], "id": "def-common.OptionedParamType.options", "type": "Array", "label": "options", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/optioned.ts#L20" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.OptionedValueProp", "text": "OptionedValueProp" }, "[]" ] }, { "id": "def-common.OptionedParamType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "config", "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22" } } ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/optioned.ts#L19" }, "initialIsOpen": false }, { "id": "def-common.StringParamType", "type": "Class", "tags": [], "label": "StringParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.StringParamType", "text": "StringParamType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ], "children": [ { "id": "def-common.StringParamType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "config", "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/string.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/string.ts#L13" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/string.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/string.ts#L13" } } ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/string.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/string.ts#L12" }, "initialIsOpen": false }, { "id": "def-common.InvalidEsCalendarIntervalError", "type": "Class", "tags": [], "label": "InvalidEsCalendarIntervalError", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.InvalidEsCalendarIntervalError", "text": "InvalidEsCalendarIntervalError" }, " extends Error" ], "children": [ { "id": "def-common.InvalidEsCalendarIntervalError.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "string", "label": "interval", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L14" } }, { "type": "number", "label": "value", "isRequired": true, "signature": [ "number" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L15" } }, { "type": "CompoundType", "label": "unit", "isRequired": true, "signature": [ "Unit" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L16" } }, { "type": "string", "label": "type", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L17" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L13" } } ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L12" }, "initialIsOpen": false }, { "id": "def-common.InvalidEsIntervalFormatError", "type": "Class", "tags": [], "label": "InvalidEsIntervalFormatError", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.InvalidEsIntervalFormatError", "text": "InvalidEsIntervalFormatError" }, " extends Error" ], "children": [ { "id": "def-common.InvalidEsIntervalFormatError.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "string", "label": "interval", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts#L12" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts#L12" } } ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", "lineNumber": 11, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts#L11" }, "initialIsOpen": false }, { "id": "def-common.Ipv4Address", "type": "Class", "tags": [], "label": "Ipv4Address", "description": [], "children": [ { "id": "def-common.Ipv4Address.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "CompoundType", "label": "ipAddress", "isRequired": true, "signature": [ "React.ReactText" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L25" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L25" } }, { "id": "def-common.Ipv4Address.toString", "type": "Function", "label": "toString", "signature": [ "() => string" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", "lineNumber": 50, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L50" } }, { "id": "def-common.Ipv4Address.valueOf", "type": "Function", "label": "valueOf", "signature": [ "() => number" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", "lineNumber": 60, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L60" } } ], "source": { "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L22" }, "initialIsOpen": false }, { "id": "def-common.RequestFailure", "type": "Class", "tags": [], "label": "RequestFailure", "description": [ "\nRequest Failure - When an entire multi request fails" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.RequestFailure", "text": "RequestFailure" }, " extends ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.KbnError", "text": "KbnError" } ], "children": [ { "tags": [], "id": "def-common.RequestFailure.resp", "type": "Object", "label": "resp", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/request_error.ts#L19" }, "signature": [ "SearchResponse", " | undefined" ] }, { "id": "def-common.RequestFailure.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "CompoundType", "label": "err", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchError", "text": "SearchError" }, " | null" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/request_error.ts#L20" } }, { "type": "Object", "label": "resp", "isRequired": false, "signature": [ "SearchResponse", " | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/request_error.ts#L20" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/request_error.ts#L20" } } ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/request_error.ts#L18" }, "initialIsOpen": false }, { "id": "def-common.SearchSource", "type": "Class", "tags": [ "public" ], "label": "SearchSource", "description": [], "children": [ { "tags": [], "id": "def-common.SearchSource.history", "type": "Array", "label": "history", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 111, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L111" }, "signature": [ "Record[]" ] }, { "id": "def-common.SearchSource.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "fields", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 115, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L115" } }, { "type": "Object", "label": "dependencies", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceDependencies", "text": "SearchSourceDependencies" } ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 115, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L115" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 115, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L115" } }, { "id": "def-common.SearchSource.setPreferredSearchStrategyId", "type": "Function", "label": "setPreferredSearchStrategyId", "signature": [ "(searchStrategyId: string) => void" ], "description": [ "**\nPUBLIC API\n\ninternal, dont use" ], "children": [ { "type": "string", "label": "searchStrategyId", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 133, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L133" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 133, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L133" } }, { "id": "def-common.SearchSource.setField", "type": "Function", "label": "setField", "signature": [ "(field: K, value: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]) => this" ], "description": [ "\nsets value to a single search source field" ], "children": [ { "type": "Uncategorized", "label": "field", "isRequired": true, "signature": [ "K" ], "description": [ ": field name" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 142, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L142" } }, { "type": "Uncategorized", "label": "value", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]" ], "description": [ ": value for the field" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 142, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L142" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 142, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L142" } }, { "id": "def-common.SearchSource.removeField", "type": "Function", "label": "removeField", "signature": [ "(field: K) => this" ], "description": [ "\nremove field" ], "children": [ { "type": "Uncategorized", "label": "field", "isRequired": true, "signature": [ "K" ], "description": [ ": field name" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 154, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L154" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 154, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L154" } }, { "id": "def-common.SearchSource.setFields", "type": "Function", "label": "setFields", "signature": [ "(newFields: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, ") => this" ], "description": [ "\nInternal, do not use. Overrides all search source fields with the new field array.\n" ], "children": [ { "type": "Object", "label": "newFields", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "description": [ "New field array." ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 165, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L165" } } ], "tags": [ "private" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 165, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L165" } }, { "id": "def-common.SearchSource.getId", "type": "Function", "label": "getId", "signature": [ "() => string" ], "description": [ "\nreturns search source id" ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 173, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L173" } }, { "id": "def-common.SearchSource.getFields", "type": "Function", "label": "getFields", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "description": [ "\nreturns all search source fields" ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 180, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L180" } }, { "id": "def-common.SearchSource.getField", "type": "Function", "label": "getField", "signature": [ "(field: K, recurse?: boolean) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]" ], "description": [ "\nGets a single field from the fields" ], "children": [ { "type": "Uncategorized", "label": "field", "isRequired": true, "signature": [ "K" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 187, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L187" } }, { "type": "boolean", "label": "recurse", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 187, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L187" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 187, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L187" } }, { "id": "def-common.SearchSource.getOwnField", "type": "Function", "label": "getOwnField", "signature": [ "(field: K) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]" ], "description": [ "\nGet the field from our own fields, don't traverse up the chain" ], "children": [ { "type": "Uncategorized", "label": "field", "isRequired": true, "signature": [ "K" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 198, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L198" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 198, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L198" } }, { "id": "def-common.SearchSource.create", "type": "Function", "label": "create", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" } ], "description": [], "children": [], "tags": [ "deprecated" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 205, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L205" } }, { "id": "def-common.SearchSource.createCopy", "type": "Function", "label": "createCopy", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" } ], "description": [ "\ncreates a copy of this search source (without its children)" ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 212, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L212" } }, { "id": "def-common.SearchSource.createChild", "type": "Function", "label": "createChild", "signature": [ "(options?: {}) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" } ], "description": [ "\ncreates a new child search source" ], "children": [ { "type": "Object", "label": "options", "isRequired": true, "signature": [ "{}" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 226, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L226" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 226, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L226" } }, { "id": "def-common.SearchSource.setParent", "type": "Function", "label": "setParent", "signature": [ "(parent?: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceOptions", "text": "SearchSourceOptions" }, ") => this" ], "description": [ "\nSet a searchSource that this source should inherit from" ], "children": [ { "type": "Object", "label": "parent", "isRequired": false, "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined" ], "description": [ "- the parent searchSource" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 238, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L238" } }, { "type": "Object", "label": "options", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceOptions", "text": "SearchSourceOptions" } ], "description": [ "- the inherit options" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 238, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L238" } } ], "tags": [ "return" ], "returnComment": [ "- chainable" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 238, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L238" } }, { "id": "def-common.SearchSource.getParent", "type": "Function", "label": "getParent", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, " | undefined" ], "description": [ "\nGet the parent of this SearchSource" ], "children": [], "tags": [ "return" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 248, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L248" } }, { "id": "def-common.SearchSource.fetch$", "type": "Function", "label": "fetch$", "signature": [ "(options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => ", "Observable", "<", "SearchResponse", ">" ], "description": [ "\nFetch this source from Elasticsearch, returning an observable over the response(s)" ], "children": [ { "type": "Object", "label": "options", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" } ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 256, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L256" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 256, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L256" } }, { "id": "def-common.SearchSource.fetch", "type": "Function", "label": "fetch", "signature": [ "(options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => Promise<", "SearchResponse", ">" ], "description": [ "\nFetch this source and reject the returned Promise on error" ], "children": [ { "type": "Object", "label": "options", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" } ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 283, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L283" } } ], "tags": [ "deprecated" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 283, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L283" } }, { "id": "def-common.SearchSource.onRequestStart", "type": "Function", "label": "onRequestStart", "signature": [ "(handler: (searchSource: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise) => void" ], "description": [ "\n Add a handler that will be notified whenever requests start" ], "children": [ { "type": "Function", "label": "handler", "isRequired": true, "signature": [ "(searchSource: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 293, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L293" } } ], "tags": [ "return" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 292, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L292" } }, { "id": "def-common.SearchSource.getSearchRequestBody", "type": "Function", "label": "getSearchRequestBody", "signature": [ "() => Promise" ], "description": [ "\nReturns body contents of the search request, often referred as query DSL." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 301, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L301" } }, { "id": "def-common.SearchSource.destroy", "type": "Function", "label": "destroy", "signature": [ "() => void" ], "description": [ "\nCompletely destroy the SearchSource." ], "children": [], "tags": [ "return" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 310, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L310" } }, { "id": "def-common.SearchSource.getSerializedFields", "type": "Function", "label": "getSerializedFields", "signature": [ "(recurse?: boolean) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "description": [ "\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})" ], "children": [ { "type": "boolean", "label": "recurse", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 688, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L688" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 688, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L688" } }, { "id": "def-common.SearchSource.serialize", "type": "Function", "label": "serialize", "signature": [ "() => { searchSourceJSON: string; references: ", { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "description": [ "\nSerializes the instance to a JSON string and a set of referenced objects.\nUse this method to get a representation of the search source which can be stored in a saved object.\n\nThe references returned by this function can be mixed with other references in the same object,\nhowever make sure there are no name-collisions. The references will be named `kibanaSavedObjectMeta.searchSourceJSON.index`\nand `kibanaSavedObjectMeta.searchSourceJSON.filter[].meta.index`.\n\nUsing `createSearchSource`, the instance can be re-created." ], "children": [], "tags": [ "public" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 717, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L717" } } ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 103, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L103" }, "initialIsOpen": false }, { "id": "def-common.SearchSourceService", "type": "Class", "tags": [], "label": "SearchSourceService", "description": [], "children": [ { "id": "def-common.SearchSourceService.setup", "type": "Function", "label": "setup", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source_service.ts#L13" } }, { "id": "def-common.SearchSourceService.start", "type": "Function", "label": "start", "signature": [ "(indexPatterns: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPatternsService", "text": "IndexPatternsService" }, ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"migrate\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, dependencies: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceDependencies", "text": "SearchSourceDependencies" }, ") => { create: (searchSourceFields?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, ") => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ">; createEmpty: () => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" } ], "description": [], "children": [ { "type": "Object", "label": "indexPatterns", "isRequired": true, "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPatternsService", "text": "IndexPatternsService" }, ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"migrate\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source_service.ts#L15" } }, { "type": "Object", "label": "dependencies", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceDependencies", "text": "SearchSourceDependencies" } ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source_service.ts#L15" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source_service.ts#L15" } }, { "id": "def-common.SearchSourceService.stop", "type": "Function", "label": "stop", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source_service.ts#L30" } } ], "source": { "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source_service.ts#L12" }, "initialIsOpen": false } ], "functions": [ { "id": "def-common.isAutoInterval", "type": "Function", "children": [ { "type": "Unknown", "label": "value", "isRequired": true, "signature": [ "unknown" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/_interval_options.ts#L13" } } ], "signature": [ "(value: unknown) => boolean" ], "description": [], "label": "isAutoInterval", "source": { "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/_interval_options.ts#L13" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.isBucketAggType", "type": "Function", "label": "isBucketAggType", "signature": [ "(aggConfig: any) => boolean" ], "description": [], "children": [ { "type": "Any", "label": "aggConfig", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 49, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L49" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 49, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L49" }, "initialIsOpen": false }, { "id": "def-common.aggDateHistogram", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggDateHistogram", "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.isDateHistogramBucketAggConfig", "type": "Function", "label": "isDateHistogramBucketAggConfig", "signature": [ "(agg: any) => boolean" ], "description": [], "children": [ { "type": "Any", "label": "agg", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 57, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L57" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 57, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L57" }, "initialIsOpen": false }, { "id": "def-common.getDateHistogramBucketAgg", "type": "Function", "children": [ { "type": "Object", "label": "{\n calculateBounds,\n isDefaultTimezone,\n getConfig,\n}", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateHistogramBucketAggDependencies", "text": "DateHistogramBucketAggDependencies" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 74, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L74" } } ], "signature": [ "({ calculateBounds, isDefaultTimezone, getConfig, }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateHistogramBucketAggDependencies", "text": "DateHistogramBucketAggDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketDateHistogramAggConfig", "text": "IBucketDateHistogramAggConfig" }, ">" ], "description": [], "label": "getDateHistogramBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 74, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L74" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggDateRange", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggDateRange", "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range_fn.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_range_fn.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getDateRangeBucketAgg", "type": "Function", "children": [ { "type": "Object", "label": "{\n isDefaultTimezone,\n getConfig,\n}", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRangeBucketAggDependencies", "text": "DateRangeBucketAggDependencies" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_range.ts#L37" } } ], "signature": [ "({ isDefaultTimezone, getConfig, }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRangeBucketAggDependencies", "text": "DateRangeBucketAggDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "description": [], "label": "getDateRangeBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_range.ts#L37" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggFilter", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggFilter", "source": { "path": "src/plugins/data/common/search/aggs/buckets/filter_fn.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filter_fn.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getFilterBucketAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "description": [], "label": "getFilterBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filter.ts#L24" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggFilters", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggFilters", "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters_fn.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filters_fn.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getFiltersBucketAgg", "type": "Function", "children": [ { "type": "Object", "label": "{ getConfig }", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FiltersBucketAggDependencies", "text": "FiltersBucketAggDependencies" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "lineNumber": 43, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filters.ts#L43" } } ], "signature": [ "({ getConfig }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FiltersBucketAggDependencies", "text": "FiltersBucketAggDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "description": [], "label": "getFiltersBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "lineNumber": 43, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filters.ts#L43" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggGeoHash", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggGeoHash", "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts#L29" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getGeoHashBucketAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "description": [], "label": "getGeoHashBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L37" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggGeoTile", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggGeoTile", "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts#L26" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getGeoTitleBucketAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "" ], "description": [], "label": "getGeoTitleBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L29" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggHistogram", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggHistogram", "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram_fn.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram_fn.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getHistogramBucketAgg", "type": "Function", "children": [ { "type": "Object", "label": "{\n getConfig,\n getFieldFormatsStart,\n}", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.HistogramBucketAggDependencies", "text": "HistogramBucketAggDependencies" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 51, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L51" } } ], "signature": [ "({ getConfig, getFieldFormatsStart, }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.HistogramBucketAggDependencies", "text": "HistogramBucketAggDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketHistogramAggConfig", "text": "IBucketHistogramAggConfig" }, ">" ], "description": [], "label": "getHistogramBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 51, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L51" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggIpRange", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggIpRange", "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/ip_range_fn.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getIpRangeBucketAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "description": [], "label": "getIpRangeBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L38" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.convertDateRangeToString", "type": "Function", "label": "convertDateRangeToString", "signature": [ "({ from, to }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRangeKey", "text": "DateRangeKey" }, ", format: (val: any) => string) => string" ], "description": [], "children": [ { "type": "Object", "label": "{ from, to }", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRangeKey", "text": "DateRangeKey" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L14" } }, { "type": "Function", "label": "format", "isRequired": true, "signature": [ "(val: any) => string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L14" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L14" }, "initialIsOpen": false }, { "id": "def-common.convertIPRangeToString", "type": "Function", "children": [ { "type": "CompoundType", "label": "range", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRangeKey", "text": "IpRangeKey" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L22" } }, { "type": "Function", "label": "format", "isRequired": true, "signature": [ "(val: any) => string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L22" } } ], "signature": [ "(range: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRangeKey", "text": "IpRangeKey" }, ", format: (val: any) => string) => string" ], "description": [], "label": "convertIPRangeToString", "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L22" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.calcAutoIntervalNear", "type": "Function", "label": "calcAutoIntervalNear", "signature": [ "(targetBucketCount: number, duration: number) => moment.Duration" ], "description": [ "\nUsing some simple rules we pick a \"pretty\" interval that will\nproduce around the number of buckets desired given a time range.\n" ], "children": [ { "type": "number", "label": "targetBucketCount", "isRequired": true, "signature": [ "number" ], "description": [ "desired number of buckets" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "lineNumber": 225, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L225" } }, { "type": "number", "label": "duration", "isRequired": true, "signature": [ "number" ], "description": [ "time range the agg covers" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "lineNumber": 225, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L225" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "lineNumber": 225, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L225" }, "initialIsOpen": false }, { "id": "def-common.calcAutoIntervalLessThan", "type": "Function", "label": "calcAutoIntervalLessThan", "signature": [ "(maxBucketCount: number, duration: number) => moment.Duration" ], "description": [ "\nPick a \"pretty\" interval that produces no more than the maxBucketCount\nfor the given time range.\n" ], "children": [ { "type": "number", "label": "maxBucketCount", "isRequired": true, "signature": [ "number" ], "description": [ "maximum number of buckets to create" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "lineNumber": 252, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L252" } }, { "type": "number", "label": "duration", "isRequired": true, "signature": [ "number" ], "description": [ "amount of time covered by the agg" ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "lineNumber": 252, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L252" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "lineNumber": 252, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L252" }, "initialIsOpen": false }, { "id": "def-common.isType", "type": "Function", "children": [ { "type": "Array", "label": "types", "isRequired": true, "signature": [ "string[]" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L13" } } ], "signature": [ "(...types: string[]) => (agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => boolean" ], "description": [], "label": "isType", "source": { "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L13" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "tags": [], "id": "def-common.isNumberType", "type": "Function", "label": "isNumberType", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L21" }, "signature": [ "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => boolean" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.isStringType", "type": "Function", "label": "isStringType", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L22" }, "signature": [ "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => boolean" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.isStringOrNumberType", "type": "Function", "label": "isStringOrNumberType", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L23" }, "signature": [ "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => boolean" ], "initialIsOpen": false }, { "id": "def-common.aggRange", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggRange", "source": { "path": "src/plugins/data/common/search/aggs/buckets/range_fn.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/range_fn.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getRangeBucketAgg", "type": "Function", "children": [ { "type": "Object", "label": "{ getFieldFormatsStart }", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.RangeBucketAggDependencies", "text": "RangeBucketAggDependencies" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/range.ts#L38" } } ], "signature": [ "({ getFieldFormatsStart }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.RangeBucketAggDependencies", "text": "RangeBucketAggDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "description": [], "label": "getRangeBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/range.ts#L38" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggSignificantTerms", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggSignificantTerms", "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts#L28" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getSignificantTermsBucketAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "description": [], "label": "getSignificantTermsBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L29" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggTerms", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggTerms", "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms_fn.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms_fn.ts#L31" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getTermsBucketAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "description": [], "label": "getTermsBucketAgg", "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 65, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L65" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggAvg", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggAvg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/avg_fn.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/avg_fn.ts#L20" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getAvgMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getAvgMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/avg.ts#L24" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggBucketAvg", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggBucketAvg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getBucketAvgMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getBucketAvgMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_avg.ts#L31" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggBucketMax", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggBucketMax", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getBucketMaxMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getBucketMaxMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_max.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggBucketMin", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggBucketMin", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getBucketMinMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getBucketMinMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_min.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggBucketSum", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggBucketSum", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getBucketSumMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getBucketSumMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_sum.ts#L30" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggCardinality", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggCardinality", "source": { "path": "src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/cardinality_fn.ts#L25" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getCardinalityMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getCardinalityMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/cardinality.ts#L24" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getCountMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getCountMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/count.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/count.ts#L14" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggCount", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggCount", "source": { "path": "src/plugins/data/common/search/aggs/metrics/count_fn.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/count_fn.ts#L25" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggCumulativeSum", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggCumulativeSum", "source": { "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts#L27" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getCumulativeSumMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getCumulativeSumMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L31" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggDerivative", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggDerivative", "source": { "path": "src/plugins/data/common/search/aggs/metrics/derivative_fn.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/derivative_fn.ts#L27" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getDerivativeMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getDerivativeMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/derivative.ts#L31" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggGeoBounds", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggGeoBounds", "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts#L25" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getGeoBoundsMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getGeoBoundsMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/geo_bounds.ts#L28" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggGeoCentroid", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggGeoCentroid", "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts#L25" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getGeoCentroidMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getGeoCentroidMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/geo_centroid.ts#L28" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggMax", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggMax", "source": { "path": "src/plugins/data/common/search/aggs/metrics/max_fn.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/max_fn.ts#L20" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getMaxMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getMaxMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/max.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/max.ts#L24" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggMedian", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggMedian", "source": { "path": "src/plugins/data/common/search/aggs/metrics/median_fn.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/median_fn.ts#L25" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getMedianMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getMedianMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/median.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/median.ts#L24" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.isMetricAggType", "type": "Function", "label": "isMetricAggType", "signature": [ "(aggConfig: any) => boolean" ], "description": [], "children": [ { "type": "Any", "label": "aggConfig", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 75, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L75" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 75, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L75" }, "initialIsOpen": false }, { "id": "def-common.aggMin", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggMin", "source": { "path": "src/plugins/data/common/search/aggs/metrics/min_fn.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/min_fn.ts#L20" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getMinMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getMinMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/min.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/min.ts#L24" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggMovingAvg", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggMovingAvg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts#L27" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getMovingAvgMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getMovingAvgMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L33" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggPercentileRanks", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggPercentileRanks", "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts#L25" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getPercentileRanksMetricAgg", "type": "Function", "children": [ { "type": "Object", "label": "{\n getFieldFormatsStart,\n}", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.PercentileRanksMetricAggDependencies", "text": "PercentileRanksMetricAggDependencies" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 52, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L52" } } ], "signature": [ "({ getFieldFormatsStart, }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.PercentileRanksMetricAggDependencies", "text": "PercentileRanksMetricAggDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", "IResponseAggConfig", ">" ], "description": [], "label": "getPercentileRanksMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 52, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L52" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggPercentiles", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggPercentiles", "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentiles_fn.ts#L25" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getPercentilesMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", "IResponseAggConfig", ">" ], "description": [], "label": "getPercentilesMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L38" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggSerialDiff", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggSerialDiff", "source": { "path": "src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts#L27" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getSerialDiffMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getSerialDiffMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L31" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggStdDeviation", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggStdDeviation", "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts#L25" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getStdDeviationMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IStdDevAggConfig", "text": "IStdDevAggConfig" }, ">" ], "description": [], "label": "getStdDeviationMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 73, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L73" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggSum", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggSum", "source": { "path": "src/plugins/data/common/search/aggs/metrics/sum_fn.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/sum_fn.ts#L20" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getSumMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "description": [], "label": "getSumMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/sum.ts#L24" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.aggTopHit", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], "label": "aggTopHit", "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/top_hit_fn.ts#L25" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getTopHitMetricAgg", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "" ], "description": [], "label": "getTopHitMetricAgg", "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L31" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getNumberHistogramIntervalByDatatableColumn", "type": "Function", "children": [ { "type": "Object", "label": "column", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts#L19" } } ], "signature": [ "(column: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, ") => number | undefined" ], "description": [ "\nHelper function returning the used interval for data table column created by the histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a histogram aggregation of the esaggs data source,\nthis function will return undefined." ], "label": "getNumberHistogramIntervalByDatatableColumn", "source": { "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts#L19" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getCalculateAutoTimeExpression", "type": "Function", "label": "getCalculateAutoTimeExpression", "signature": [ "(getConfig: (key: string) => any) => (range: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => string | undefined" ], "description": [], "children": [ { "type": "Function", "label": "getConfig", "isRequired": true, "signature": [ "(key: string) => any" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts#L16" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts#L16" }, "initialIsOpen": false }, { "id": "def-common.dateHistogramInterval", "type": "Function", "label": "dateHistogramInterval", "signature": [ "(interval: string) => Interval" ], "description": [ "\nChecks whether a given Elasticsearch interval is a calendar or fixed interval\nand returns an object containing the appropriate date_histogram property for that\ninterval. So it will return either an object containing the fixed_interval key for\nthat interval or a calendar_interval. If the specified interval was not a valid Elasticsearch\ninterval this method will throw an error.\n\nYou can simply spread the returned value of this method into your date_histogram." ], "children": [ { "type": "string", "label": "interval", "isRequired": true, "signature": [ "string" ], "description": [ "The interval string to return the appropriate date_histogram key for." ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts#L31" } } ], "tags": [ "example" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts#L31" }, "initialIsOpen": false }, { "id": "def-common.isValidEsInterval", "type": "Function", "label": "isValidEsInterval", "signature": [ "(interval: string) => boolean" ], "description": [ "\nChecks whether a given interval string (e.g. 1w, 24h, ...) is a valid Elasticsearch interval.\nWill return false if the interval is not valid in Elasticsearch, otherwise true.\nInvalid intervals might be: 2f, since there is no unit 'f'; 2w, since weeks and month intervals\nare only allowed with a value of 1, etc.\n" ], "children": [ { "type": "string", "label": "interval", "isRequired": true, "signature": [ "string" ], "description": [ "The interval string like 1w, 24h" ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts#L20" } } ], "tags": [], "returnComment": [ "True if the interval is valid for Elasticsearch" ], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts#L20" }, "initialIsOpen": false }, { "id": "def-common.isValidInterval", "type": "Function", "label": "isValidInterval", "signature": [ "(value: string, baseInterval: string | undefined) => boolean" ], "description": [], "children": [ { "type": "string", "label": "value", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts#L24" } }, { "type": "string", "label": "baseInterval", "isRequired": false, "signature": [ "string | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts#L24" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts#L24" }, "initialIsOpen": false }, { "id": "def-common.parseInterval", "type": "Function", "label": "parseInterval", "signature": [ "(interval: string) => moment.Duration | null" ], "description": [], "children": [ { "type": "string", "label": "interval", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L29" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L29" }, "initialIsOpen": false }, { "id": "def-common.splitStringInterval", "type": "Function", "children": [ { "type": "string", "label": "interval", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L16" } } ], "signature": [ "(interval: string) => { value: number; unit: ", "Unit", "; } | null" ], "description": [], "label": "splitStringInterval", "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L16" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.parseEsInterval", "type": "Function", "label": "parseEsInterval", "signature": [ "(interval: string) => { value: number; unit: ", "Unit", "; type: \"calendar\" | \"fixed\"; }" ], "description": [ "\nExtracts interval properties from an ES interval string. Disallows unrecognized interval formats\nand fractional values. Converts some intervals from \"calendar\" to \"fixed\" when the number of\nunits is larger than 1, and throws an error for others.\n\nConversion rules:\n\n| Interval | Single unit type | Multiple units type |\n| -------- | ---------------- | ------------------- |\n| ms | fixed | fixed |\n| s | fixed | fixed |\n| m | calendar | fixed |\n| h | calendar | fixed |\n| d | calendar | fixed |\n| w | calendar | N/A - disallowed |\n| M | calendar | N/A - disallowed |\n| y | calendar | N/A - disallowed |\n" ], "children": [ { "type": "string", "label": "interval", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", "lineNumber": 39, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L39" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", "lineNumber": 39, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L39" }, "initialIsOpen": false }, { "id": "def-common.toAbsoluteDates", "type": "Function", "label": "toAbsoluteDates", "signature": [ "(range: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => { from: Date; to: Date; } | undefined" ], "description": [], "children": [ { "type": "Object", "label": "range", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts#L12" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts#L12" }, "initialIsOpen": false }, { "id": "def-common.propFilter", "type": "Function", "label": "propFilter", "signature": [ "(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]" ], "description": [ "\nFilters out a list by a given filter. This is currently used to implement:\n - fieldType filters a list of fields by their type property\n - aggFilter filters a list of aggs by their name property\n" ], "children": [ { "type": "Uncategorized", "label": "prop", "isRequired": true, "signature": [ "P" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/prop_filter.ts#L20" } } ], "tags": [], "returnComment": [ "the filter function which can be registered with angular" ], "source": { "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/prop_filter.ts#L20" }, "initialIsOpen": false }, { "id": "def-common.inferTimeZone", "type": "Function", "label": "inferTimeZone", "signature": [ "(params: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsDateHistogram", "text": "AggParamsDateHistogram" }, ", indexPattern: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, ", isDefaultTimezone: () => boolean, getConfig: (key: string) => T) => string" ], "description": [], "children": [ { "type": "Object", "label": "params", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsDateHistogram", "text": "AggParamsDateHistogram" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L14" } }, { "type": "Object", "label": "indexPattern", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L15" } }, { "type": "Function", "label": "isDefaultTimezone", "isRequired": true, "signature": [ "() => boolean" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L16" } }, { "type": "Function", "label": "getConfig", "isRequired": true, "signature": [ "(key: string) => T" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L17" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L13" }, "initialIsOpen": false }, { "id": "def-common.handleRequest", "type": "Function", "children": [ { "type": "Object", "label": "{\n abortSignal,\n aggs,\n filters,\n indexPattern,\n inspectorAdapters,\n metricsAtAllLevels,\n partialRows,\n query,\n searchSessionId,\n searchSourceService,\n timeFields,\n timeRange,\n getNow,\n}", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.RequestHandlerParams", "text": "RequestHandlerParams" } ], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", "lineNumber": 44, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/esaggs/request_handler.ts#L44" } } ], "signature": [ "({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, metricsAtAllLevels, partialRows, query, searchSessionId, searchSourceService, timeFields, timeRange, getNow, }: ", "RequestHandlerParams", ") => Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">" ], "description": [], "label": "handleRequest", "source": { "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", "lineNumber": 44, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/esaggs/request_handler.ts#L44" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getRequestInspectorStats", "type": "Function", "label": "getRequestInspectorStats", "signature": [ "(searchSource: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">) => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestStatistics", "text": "RequestStatistics" } ], "description": [], "children": [ { "type": "Object", "label": "searchSource", "isRequired": true, "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" ], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L22" } } ], "tags": [ "public" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L22" }, "initialIsOpen": false }, { "id": "def-common.getResponseInspectorStats", "type": "Function", "label": "getResponseInspectorStats", "signature": [ "(resp: ", "SearchResponse", ", searchSource: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined) => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestStatistics", "text": "RequestStatistics" } ], "description": [], "children": [ { "type": "Object", "label": "resp", "isRequired": true, "signature": [ "SearchResponse", "" ], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", "lineNumber": 53, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L53" } }, { "type": "Object", "label": "searchSource", "isRequired": false, "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", "lineNumber": 54, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L54" } } ], "tags": [ "public" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", "lineNumber": 52, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L52" }, "initialIsOpen": false }, { "id": "def-common.functionWrapper", "type": "Function", "children": [ { "type": "Object", "label": "spec", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" } ], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/utils/function_wrapper.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/utils/function_wrapper.ts#L16" } } ], "signature": [ "(spec: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ") => (context: object | null, args?: Record, handlers?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", "SerializableState", ">) => any" ], "description": [ "\nTakes a function spec and passes in default args,\noverriding with any provided args." ], "label": "functionWrapper", "source": { "path": "src/plugins/data/common/search/expressions/utils/function_wrapper.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/utils/function_wrapper.ts#L16" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.createSearchSource", "type": "Function", "children": [ { "type": "Object", "label": "indexPatterns", "isRequired": true, "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPatternsService", "text": "IndexPatternsService" }, ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"migrate\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/create_search_source.ts", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/create_search_source.ts#L32" } }, { "type": "Object", "label": "searchSourceDependencies", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceDependencies", "text": "SearchSourceDependencies" } ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/create_search_source.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/create_search_source.ts#L33" } } ], "signature": [ "(indexPatterns: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPatternsService", "text": "IndexPatternsService" }, ", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"migrate\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, searchSourceDependencies: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceDependencies", "text": "SearchSourceDependencies" }, ") => (searchSourceFields?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, ") => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ">" ], "description": [ "\nDeserializes a json string and a set of referenced objects to a `SearchSource` instance.\nUse this method to re-create the search source serialized using `searchSource.serialize`.\n\nThis function is a factory function that returns the actual utility when calling it with the\nrequired service dependency (index patterns contract). A pre-wired version is also exposed in\nthe start contract of the data plugin as part of the search service\n" ], "label": "createSearchSource", "source": { "path": "src/plugins/data/common/search/search_source/create_search_source.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/create_search_source.ts#L31" }, "tags": [ "return", "public" ], "returnComment": [ "Wired utility function taking two parameters `searchSourceJson`, the json string\nreturned by `serializeSearchSource` and `references`, a list of references including the ones\nreturned by `serializeSearchSource`." ], "initialIsOpen": false }, { "id": "def-common.injectReferences", "type": "Function", "children": [ { "type": "CompoundType", "label": "searchSourceFields", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " & { indexRefName: string; }" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/inject_references.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/inject_references.ts#L13" } }, { "type": "Array", "label": "references", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/inject_references.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/inject_references.ts#L14" } } ], "signature": [ "(searchSourceFields: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " & { indexRefName: string; }, references: ", "SavedObjectReference", "[]) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "description": [], "label": "injectReferences", "source": { "path": "src/plugins/data/common/search/search_source/inject_references.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/inject_references.ts#L12" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.extractReferences", "type": "Function", "children": [ { "type": "Object", "label": "state", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/extract_references.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/extract_references.ts#L14" } } ], "signature": [ "(state: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, ") => [", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " & { indexRefName?: string | undefined; }, ", "SavedObjectReference", "[]]" ], "description": [], "label": "extractReferences", "source": { "path": "src/plugins/data/common/search/search_source/extract_references.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/extract_references.ts#L13" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.parseSearchSourceJSON", "type": "Function", "children": [ { "type": "string", "label": "searchSourceJSON", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/parse_json.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/parse_json.ts#L12" } } ], "signature": [ "(searchSourceJSON: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "description": [], "label": "parseSearchSourceJSON", "source": { "path": "src/plugins/data/common/search/search_source/parse_json.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/parse_json.ts#L12" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getSearchParams", "type": "Function", "label": "getSearchParams", "signature": [ "(getConfig: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.GetConfigFn", "text": "GetConfigFn" }, ") => { preference: any; }" ], "description": [], "children": [ { "type": "Function", "label": "getConfig", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.GetConfigFn", "text": "GetConfigFn" } ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L16" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L16" }, "initialIsOpen": false }, { "id": "def-common.getSearchParamsFromRequest", "type": "Function", "label": "getSearchParamsFromRequest", "signature": [ "(searchRequest: Record, dependencies: { getConfig: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.GetConfigFn", "text": "GetConfigFn" }, "; }) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchRequestParams", "text": "ISearchRequestParams" }, ">" ], "description": [], "children": [ { "type": "Object", "label": "searchRequest", "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 34, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L34" } }, { "id": "def-common.getSearchParamsFromRequest.dependencies", "type": "Object", "label": "dependencies", "tags": [], "description": [], "children": [ { "tags": [], "id": "def-common.getSearchParamsFromRequest.dependencies.getConfig", "type": "Function", "label": "getConfig", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L35" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.GetConfigFn", "text": "GetConfigFn" } ] } ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L35" } } ], "tags": [ "public" ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L33" }, "initialIsOpen": false }, { "id": "def-common.getPreference", "type": "Function", "label": "getPreference", "signature": [ "(getConfig: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.GetConfigFn", "text": "GetConfigFn" }, ") => any" ], "description": [], "children": [ { "type": "Function", "label": "getConfig", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.GetConfigFn", "text": "GetConfigFn" } ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L22" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L22" }, "initialIsOpen": false }, { "id": "def-common.fetchSoon", "type": "Function", "label": "fetchSoon", "signature": [ "(request: Record, options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ", fetchHandlers: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FetchHandlers", "text": "FetchHandlers" }, ") => Promise<", "SearchResponse", ">" ], "description": [ "\nThis function introduces a slight delay in the request process to allow multiple requests to queue\nup (e.g. when a dashboard is loading)." ], "children": [ { "type": "Object", "label": "request", "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/fetch_soon.ts#L20" } }, { "type": "Object", "label": "options", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" } ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/fetch_soon.ts#L21" } }, { "type": "Object", "label": "fetchHandlers", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FetchHandlers", "text": "FetchHandlers" } ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/fetch_soon.ts#L22" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/fetch_soon.ts#L19" }, "initialIsOpen": false }, { "id": "def-common.tabify", "type": "Function", "children": [ { "type": "Object", "label": "searchSource", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" } ], "description": [], "source": { "path": "src/plugins/data/common/search/tabify/index.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/index.ts#L16" } }, { "type": "Object", "label": "esResponse", "isRequired": true, "signature": [ "SearchResponse", "" ], "description": [], "source": { "path": "src/plugins/data/common/search/tabify/index.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/index.ts#L17" } }, { "type": "CompoundType", "label": "opts", "isRequired": true, "signature": [ "Partial<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.TabbedResponseWriterOptions", "text": "TabbedResponseWriterOptions" }, "> | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.TabifyDocsOptions", "text": "TabifyDocsOptions" } ], "description": [], "source": { "path": "src/plugins/data/common/search/tabify/index.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/index.ts#L18" } } ], "signature": [ "(searchSource: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", esResponse: ", "SearchResponse", ", opts: Partial<", "TabbedResponseWriterOptions", "> | ", "TabifyDocsOptions", ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "description": [], "label": "tabify", "source": { "path": "src/plugins/data/common/search/tabify/index.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/index.ts#L15" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.tabifyDocs", "type": "Function", "children": [ { "type": "Object", "label": "esResponse", "isRequired": true, "signature": [ "SearchResponse", "" ], "description": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "lineNumber": 75, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/tabify_docs.ts#L75" } }, { "type": "Object", "label": "index", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "lineNumber": 76, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/tabify_docs.ts#L76" } }, { "type": "Object", "label": "params", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.TabifyDocsOptions", "text": "TabifyDocsOptions" } ], "description": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "lineNumber": 77, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/tabify_docs.ts#L77" } } ], "signature": [ "(esResponse: ", "SearchResponse", ", index?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined, params?: ", "TabifyDocsOptions", ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "description": [], "label": "tabifyDocs", "source": { "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "lineNumber": 74, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/tabify_docs.ts#L74" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.tabifyAggResponse", "type": "Function", "label": "tabifyAggResponse", "signature": [ "(aggConfigs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, ", esResponse: Record, respOpts: Partial<", "TabbedResponseWriterOptions", "> | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "description": [ "\nSets up the ResponseWriter and kicks off bucket collection." ], "children": [ { "type": "Object", "label": "aggConfigs", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" } ], "description": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/tabify.ts#L20" } }, { "type": "Object", "label": "esResponse", "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/tabify.ts#L21" } }, { "type": "Object", "label": "respOpts", "isRequired": false, "signature": [ "Partial<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.TabbedResponseWriterOptions", "text": "TabbedResponseWriterOptions" }, "> | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/tabify.ts#L22" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/tabify/tabify.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/tabify.ts#L19" }, "initialIsOpen": false }, { "id": "def-common.tabifyGetColumns", "type": "Function", "label": "tabifyGetColumns", "signature": [ "(aggs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[], minimalColumns: boolean) => ", "TabbedAggColumn", "[]" ], "description": [ "\nBuilds tabify columns.\n" ], "children": [ { "type": "Array", "label": "aggs", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "description": [ "- the agg configs object to which the aggregation response correlates" ], "source": { "path": "src/plugins/data/common/search/tabify/get_columns.ts", "lineNumber": 34, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/get_columns.ts#L34" } }, { "type": "boolean", "label": "minimalColumns", "isRequired": true, "signature": [ "boolean" ], "description": [ "- setting to true will only return a column for the last bucket/metric instead of one for each level" ], "source": { "path": "src/plugins/data/common/search/tabify/get_columns.ts", "lineNumber": 34, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/get_columns.ts#L34" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/tabify/get_columns.ts", "lineNumber": 34, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/tabify/get_columns.ts#L34" }, "initialIsOpen": false }, { "id": "def-common.isErrorResponse", "type": "Function", "children": [ { "type": "Object", "label": "response", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/utils.ts#L14" } } ], "signature": [ "(response?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined) => boolean | undefined" ], "description": [], "label": "isErrorResponse", "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/utils.ts#L14" }, "tags": [], "returnComment": [ "true if response had an error while executing in ES" ], "initialIsOpen": false }, { "id": "def-common.isCompleteResponse", "type": "Function", "children": [ { "type": "Object", "label": "response", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/utils.ts#L21" } } ], "signature": [ "(response?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined) => boolean" ], "description": [], "label": "isCompleteResponse", "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/utils.ts#L21" }, "tags": [], "returnComment": [ "true if response is completed successfully" ], "initialIsOpen": false }, { "id": "def-common.isPartialResponse", "type": "Function", "children": [ { "type": "Object", "label": "response", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/utils.ts#L28" } } ], "signature": [ "(response?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined) => boolean" ], "description": [], "label": "isPartialResponse", "source": { "path": "src/plugins/data/common/search/utils.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/utils.ts#L28" }, "tags": [], "returnComment": [ "true if request is still running an/d response contains partial results" ], "initialIsOpen": false } ], "interfaces": [ { "id": "def-common.AggConfigsOptions", "type": "Interface", "label": "AggConfigsOptions", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggConfigsOptions.typesRegistry", "type": "Object", "label": "typesRegistry", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L38" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggTypesRegistryStart", "text": "AggTypesRegistryStart" } ] } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L37" }, "initialIsOpen": false }, { "id": "def-common.AggTypeConfig", "type": "Interface", "label": "AggTypeConfig", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggTypeConfig", "text": "AggTypeConfig" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggTypeConfig.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L26" } }, { "tags": [], "id": "def-common.AggTypeConfig.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L27" } }, { "tags": [], "id": "def-common.AggTypeConfig.createFilter", "type": "Function", "label": "createFilter", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L28" }, "signature": [ "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L29" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.dslName", "type": "string", "label": "dslName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L30" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.expressionName", "type": "string", "label": "expressionName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L31" } }, { "tags": [], "id": "def-common.AggTypeConfig.makeLabel", "type": "CompoundType", "label": "makeLabel", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L32" }, "signature": [ "((aggConfig: TAggConfig) => string) | (() => string) | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.ordered", "type": "Any", "label": "ordered", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L33" }, "signature": [ "any" ] }, { "tags": [], "id": "def-common.AggTypeConfig.hasNoDsl", "type": "CompoundType", "label": "hasNoDsl", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 34, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L34" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.params", "type": "Array", "label": "params", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L35" }, "signature": [ "Partial[] | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.valueType", "type": "CompoundType", "label": "valueType", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 36, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L36" }, "signature": [ "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.getRequestAggs", "type": "CompoundType", "label": "getRequestAggs", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L37" }, "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.getResponseAggs", "type": "CompoundType", "label": "getResponseAggs", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L38" }, "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.customLabels", "type": "CompoundType", "label": "customLabels", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 39, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L39" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.json", "type": "CompoundType", "label": "json", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 40, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L40" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.decorateAggConfig", "type": "Function", "label": "decorateAggConfig", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 41, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L41" }, "signature": [ "(() => any) | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.postFlightRequest", "type": "Function", "label": "postFlightRequest", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 42, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L42" }, "signature": [ "((resp: any, aggConfigs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, ", aggConfig: TAggConfig, searchSource: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, inspectorRequestAdapter?: ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, " | undefined, abortSignal?: AbortSignal | undefined, searchSessionId?: string | undefined) => Promise) | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.getSerializedFormat", "type": "Function", "label": "getSerializedFormat", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 51, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L51" }, "signature": [ "((agg: TAggConfig) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.SerializedFieldFormat", "text": "SerializedFieldFormat" }, ">) | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.getValue", "type": "Function", "label": "getValue", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 52, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L52" }, "signature": [ "((agg: TAggConfig, bucket: any) => any) | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.getKey", "type": "Function", "label": "getKey", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 53, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L53" }, "signature": [ "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" ] }, { "tags": [], "id": "def-common.AggTypeConfig.getValueBucketPath", "type": "Function", "label": "getValueBucketPath", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 54, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L54" }, "signature": [ "((agg: TAggConfig) => string) | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L22" }, "initialIsOpen": false }, { "id": "def-common.IBucketAggConfig", "type": "Interface", "label": "IBucketAggConfig", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.IBucketAggConfig.type", "type": "Object", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L15" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L14" }, "initialIsOpen": false }, { "id": "def-common.BucketAggParam", "type": "Interface", "label": "BucketAggParam", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggParam", "text": "BucketAggParam" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamType", "text": "AggParamType" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.BucketAggParam.scriptable", "type": "CompoundType", "label": "scriptable", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L20" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.BucketAggParam.filterFieldTypes", "type": "CompoundType", "label": "filterFieldTypes", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L21" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, " | \"*\" | ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, "[] | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L18" }, "initialIsOpen": false }, { "id": "def-common.DateHistogramBucketAggDependencies", "type": "Interface", "label": "DateHistogramBucketAggDependencies", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.DateHistogramBucketAggDependencies.calculateBounds", "type": "Function", "label": "calculateBounds", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 48, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L48" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.CalculateBoundsFn", "text": "CalculateBoundsFn" } ] }, { "tags": [], "id": "def-common.DateHistogramBucketAggDependencies.isDefaultTimezone", "type": "Function", "label": "isDefaultTimezone", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 49, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L49" }, "signature": [ "() => boolean" ] }, { "tags": [], "id": "def-common.DateHistogramBucketAggDependencies.getConfig", "type": "Function", "label": "getConfig", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 50, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L50" }, "signature": [ "(key: string) => T" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 47, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L47" }, "initialIsOpen": false }, { "id": "def-common.IBucketDateHistogramAggConfig", "type": "Interface", "label": "IBucketDateHistogramAggConfig", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketDateHistogramAggConfig", "text": "IBucketDateHistogramAggConfig" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.IBucketDateHistogramAggConfig.buckets", "type": "Object", "label": "buckets", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 54, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L54" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.TimeBuckets", "text": "TimeBuckets" } ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 53, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L53" }, "initialIsOpen": false }, { "id": "def-common.AggParamsDateHistogram", "type": "Interface", "label": "AggParamsDateHistogram", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsDateHistogram", "text": "AggParamsDateHistogram" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsDateHistogram.field", "type": "CompoundType", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 62, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L62" }, "signature": [ "string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IFieldType", "text": "IFieldType" }, " | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDateHistogram.timeRange", "type": "Object", "label": "timeRange", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 63, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L63" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDateHistogram.useNormalizedEsInterval", "type": "CompoundType", "label": "useNormalizedEsInterval", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 64, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L64" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDateHistogram.scaleMetricValues", "type": "CompoundType", "label": "scaleMetricValues", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 65, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L65" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDateHistogram.interval", "type": "string", "label": "interval", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 66, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L66" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDateHistogram.time_zone", "type": "string", "label": "time_zone", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 67, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L67" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDateHistogram.drop_partials", "type": "CompoundType", "label": "drop_partials", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 68, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L68" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDateHistogram.format", "type": "string", "label": "format", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 69, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L69" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDateHistogram.min_doc_count", "type": "number", "label": "min_doc_count", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 70, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L70" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDateHistogram.extended_bounds", "type": "Object", "label": "extended_bounds", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 71, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L71" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" }, " | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "lineNumber": 61, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L61" }, "initialIsOpen": false }, { "id": "def-common.DateRangeBucketAggDependencies", "type": "Interface", "label": "DateRangeBucketAggDependencies", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.DateRangeBucketAggDependencies.isDefaultTimezone", "type": "Function", "label": "isDefaultTimezone", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_range.ts#L27" }, "signature": [ "() => boolean" ] }, { "tags": [], "id": "def-common.DateRangeBucketAggDependencies.getConfig", "type": "Function", "label": "getConfig", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_range.ts#L28" }, "signature": [ "(key: string) => T" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_range.ts#L26" }, "initialIsOpen": false }, { "id": "def-common.AggParamsDateRange", "type": "Interface", "label": "AggParamsDateRange", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsDateRange", "text": "AggParamsDateRange" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsDateRange.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_range.ts#L32" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDateRange.ranges", "type": "Array", "label": "ranges", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_range.ts#L33" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRangeKey", "text": "DateRangeKey" }, "[] | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDateRange.time_zone", "type": "string", "label": "time_zone", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 34, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_range.ts#L34" }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_range.ts#L31" }, "initialIsOpen": false }, { "id": "def-common.AggParamsFilter", "type": "Interface", "label": "AggParamsFilter", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsFilter", "text": "AggParamsFilter" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsFilter.geo_bounding_box", "type": "CompoundType", "label": "geo_bounding_box", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filter.ts#L21" }, "signature": [ "Partial<{ top_left: GeoPoint; top_right: GeoPoint; bottom_right: GeoPoint; bottom_left: GeoPoint; }> | { wkt: string; } | GeoBox | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filter.ts#L20" }, "initialIsOpen": false }, { "id": "def-common.FiltersBucketAggDependencies", "type": "Interface", "label": "FiltersBucketAggDependencies", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.FiltersBucketAggDependencies.getConfig", "type": "Function", "label": "getConfig", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filters.ts#L33" }, "signature": [ "(key: string) => any" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filters.ts#L32" }, "initialIsOpen": false }, { "id": "def-common.AggParamsFilters", "type": "Interface", "label": "AggParamsFilters", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsFilters", "text": "AggParamsFilters" }, " extends Pick<", "BaseAggParams", ", \"json\">" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsFilters.filters", "type": "Array", "label": "filters", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filters.ts#L37" }, "signature": [ "{ input: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.Query", "text": "Query" }, "; label: string; }[] | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "lineNumber": 36, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filters.ts#L36" }, "initialIsOpen": false }, { "id": "def-common.AggParamsGeoHash", "type": "Interface", "label": "AggParamsGeoHash", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsGeoHash", "text": "AggParamsGeoHash" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsGeoHash.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L29" } }, { "tags": [], "id": "def-common.AggParamsGeoHash.autoPrecision", "type": "CompoundType", "label": "autoPrecision", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L30" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggParamsGeoHash.precision", "type": "number", "label": "precision", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L31" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.AggParamsGeoHash.useGeocentroid", "type": "CompoundType", "label": "useGeocentroid", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L32" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggParamsGeoHash.isFilteredByCollar", "type": "CompoundType", "label": "isFilteredByCollar", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L33" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggParamsGeoHash.boundingBox", "type": "CompoundType", "label": "boundingBox", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 34, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L34" }, "signature": [ "Partial<{ top_left: GeoPoint; top_right: GeoPoint; bottom_right: GeoPoint; bottom_left: GeoPoint; }> | { wkt: string; } | GeoBox | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L28" }, "initialIsOpen": false }, { "id": "def-common.AggParamsGeoTile", "type": "Interface", "label": "AggParamsGeoTile", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsGeoTile", "text": "AggParamsGeoTile" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsGeoTile.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L24" } }, { "tags": [], "id": "def-common.AggParamsGeoTile.useGeocentroid", "type": "CompoundType", "label": "useGeocentroid", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L25" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggParamsGeoTile.precision", "type": "number", "label": "precision", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L26" }, "signature": [ "number | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L23" }, "initialIsOpen": false }, { "id": "def-common.AutoBounds", "type": "Interface", "label": "AutoBounds", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AutoBounds.min", "type": "number", "label": "min", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L26" } }, { "tags": [], "id": "def-common.AutoBounds.max", "type": "number", "label": "max", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L27" } } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L25" }, "initialIsOpen": false }, { "id": "def-common.HistogramBucketAggDependencies", "type": "Interface", "label": "HistogramBucketAggDependencies", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.HistogramBucketAggDependencies.getConfig", "type": "Function", "label": "getConfig", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L31" }, "signature": [ "(key: string) => T" ] }, { "tags": [], "id": "def-common.HistogramBucketAggDependencies.getFieldFormatsStart", "type": "Function", "label": "getFieldFormatsStart", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L32" }, "signature": [ "() => Pick, \"deserialize\" | \"getDefaultInstance\">" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L30" }, "initialIsOpen": false }, { "id": "def-common.IBucketHistogramAggConfig", "type": "Interface", "label": "IBucketHistogramAggConfig", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketHistogramAggConfig", "text": "IBucketHistogramAggConfig" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.IBucketHistogramAggConfig.setAutoBounds", "type": "Function", "label": "setAutoBounds", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 36, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L36" }, "signature": [ "(bounds: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AutoBounds", "text": "AutoBounds" }, ") => void" ] }, { "tags": [], "id": "def-common.IBucketHistogramAggConfig.getAutoBounds", "type": "Function", "label": "getAutoBounds", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L37" }, "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AutoBounds", "text": "AutoBounds" } ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L35" }, "initialIsOpen": false }, { "id": "def-common.AggParamsHistogram", "type": "Interface", "label": "AggParamsHistogram", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsHistogram", "text": "AggParamsHistogram" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsHistogram.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 41, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L41" } }, { "tags": [], "id": "def-common.AggParamsHistogram.interval", "type": "CompoundType", "label": "interval", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 42, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L42" }, "signature": [ "React.ReactText" ] }, { "tags": [], "id": "def-common.AggParamsHistogram.used_interval", "type": "CompoundType", "label": "used_interval", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 43, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L43" }, "signature": [ "string | number | undefined" ] }, { "tags": [], "id": "def-common.AggParamsHistogram.maxBars", "type": "number", "label": "maxBars", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 44, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L44" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.AggParamsHistogram.intervalBase", "type": "number", "label": "intervalBase", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 45, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L45" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.AggParamsHistogram.min_doc_count", "type": "CompoundType", "label": "min_doc_count", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 46, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L46" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggParamsHistogram.has_extended_bounds", "type": "CompoundType", "label": "has_extended_bounds", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 47, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L47" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggParamsHistogram.extended_bounds", "type": "Object", "label": "extended_bounds", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 48, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L48" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" }, " | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "lineNumber": 40, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram.ts#L40" }, "initialIsOpen": false }, { "id": "def-common.AggParamsIpRange", "type": "Interface", "label": "AggParamsIpRange", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsIpRange", "text": "AggParamsIpRange" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsIpRange.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L30" } }, { "tags": [], "id": "def-common.AggParamsIpRange.ipRangeType", "type": "CompoundType", "label": "ipRangeType", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L31" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IP_RANGE_TYPES", "text": "IP_RANGE_TYPES" }, " | undefined" ] }, { "tags": [], "id": "def-common.AggParamsIpRange.ranges", "type": "Object", "label": "ranges", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L32" }, "signature": [ "Partial<{ fromTo: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.RangeIpRangeAggKey", "text": "RangeIpRangeAggKey" }, "[]; mask: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.CidrMaskIpRangeAggKey", "text": "CidrMaskIpRangeAggKey" }, "[]; }> | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L29" }, "initialIsOpen": false }, { "id": "def-common.DateRangeKey", "type": "Interface", "label": "DateRangeKey", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.DateRangeKey.from", "type": "CompoundType", "label": "from", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "lineNumber": 10, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L10" }, "signature": [ "React.ReactText" ] }, { "tags": [], "id": "def-common.DateRangeKey.to", "type": "CompoundType", "label": "to", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "lineNumber": 11, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L11" }, "signature": [ "React.ReactText" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "lineNumber": 9, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L9" }, "initialIsOpen": false }, { "id": "def-common.CidrMaskIpRangeAggKey", "type": "Interface", "label": "CidrMaskIpRangeAggKey", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.CidrMaskIpRangeAggKey.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 10, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L10" }, "signature": [ "\"mask\"" ] }, { "tags": [], "id": "def-common.CidrMaskIpRangeAggKey.mask", "type": "string", "label": "mask", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 11, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L11" } } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 9, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L9" }, "initialIsOpen": false }, { "id": "def-common.RangeIpRangeAggKey", "type": "Interface", "label": "RangeIpRangeAggKey", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.RangeIpRangeAggKey.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L15" }, "signature": [ "\"range\"" ] }, { "tags": [], "id": "def-common.RangeIpRangeAggKey.from", "type": "string", "label": "from", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L16" } }, { "tags": [], "id": "def-common.RangeIpRangeAggKey.to", "type": "string", "label": "to", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L17" } } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L14" }, "initialIsOpen": false }, { "id": "def-common.RangeBucketAggDependencies", "type": "Interface", "label": "RangeBucketAggDependencies", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.RangeBucketAggDependencies.getFieldFormatsStart", "type": "Function", "label": "getFieldFormatsStart", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/range.ts#L26" }, "signature": [ "() => Pick, \"deserialize\" | \"getDefaultInstance\">" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/range.ts#L25" }, "initialIsOpen": false }, { "id": "def-common.AggParamsRange", "type": "Interface", "label": "AggParamsRange", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsRange", "text": "AggParamsRange" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsRange.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/range.ts#L30" } }, { "tags": [], "id": "def-common.AggParamsRange.ranges", "type": "Array", "label": "ranges", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/range.ts#L31" }, "signature": [ "{ from: number; to: number; label?: string | undefined; }[] | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/range.ts#L29" }, "initialIsOpen": false }, { "id": "def-common.AggParamsSignificantTerms", "type": "Interface", "label": "AggParamsSignificantTerms", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsSignificantTerms", "text": "AggParamsSignificantTerms" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsSignificantTerms.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L23" } }, { "tags": [], "id": "def-common.AggParamsSignificantTerms.size", "type": "number", "label": "size", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L24" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.AggParamsSignificantTerms.exclude", "type": "string", "label": "exclude", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L25" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsSignificantTerms.include", "type": "string", "label": "include", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L26" }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L22" }, "initialIsOpen": false }, { "id": "def-common.AggParamsTerms", "type": "Interface", "label": "AggParamsTerms", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsTerms", "text": "AggParamsTerms" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsTerms.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 51, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L51" } }, { "tags": [], "id": "def-common.AggParamsTerms.orderBy", "type": "string", "label": "orderBy", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 52, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L52" } }, { "tags": [], "id": "def-common.AggParamsTerms.orderAgg", "type": "Object", "label": "orderAgg", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 53, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L53" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] }, { "tags": [], "id": "def-common.AggParamsTerms.order", "type": "CompoundType", "label": "order", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 54, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L54" }, "signature": [ "\"asc\" | \"desc\" | undefined" ] }, { "tags": [], "id": "def-common.AggParamsTerms.size", "type": "number", "label": "size", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 55, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L55" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.AggParamsTerms.missingBucket", "type": "CompoundType", "label": "missingBucket", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 56, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L56" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggParamsTerms.missingBucketLabel", "type": "string", "label": "missingBucketLabel", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 57, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L57" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsTerms.otherBucket", "type": "CompoundType", "label": "otherBucket", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 58, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L58" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.AggParamsTerms.otherBucketLabel", "type": "string", "label": "otherBucketLabel", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 59, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L59" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsTerms.exclude", "type": "string", "label": "exclude", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 61, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L61" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsTerms.include", "type": "string", "label": "include", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 62, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L62" }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 50, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L50" }, "initialIsOpen": false }, { "id": "def-common.AggParamsAvg", "type": "Interface", "label": "AggParamsAvg", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsAvg", "text": "AggParamsAvg" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsAvg.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/avg.ts#L21" } } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/avg.ts#L20" }, "initialIsOpen": false }, { "id": "def-common.AggParamsBucketAvg", "type": "Interface", "label": "AggParamsBucketAvg", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsBucketAvg", "text": "AggParamsBucketAvg" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsBucketAvg.customMetric", "type": "Object", "label": "customMetric", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_avg.ts#L19" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] }, { "tags": [], "id": "def-common.AggParamsBucketAvg.customBucket", "type": "Object", "label": "customBucket", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_avg.ts#L20" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_avg.ts#L18" }, "initialIsOpen": false }, { "id": "def-common.AggParamsBucketMax", "type": "Interface", "label": "AggParamsBucketMax", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsBucketMax", "text": "AggParamsBucketMax" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsBucketMax.customMetric", "type": "Object", "label": "customMetric", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_max.ts#L18" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] }, { "tags": [], "id": "def-common.AggParamsBucketMax.customBucket", "type": "Object", "label": "customBucket", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_max.ts#L19" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_max.ts#L17" }, "initialIsOpen": false }, { "id": "def-common.AggParamsBucketMin", "type": "Interface", "label": "AggParamsBucketMin", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsBucketMin", "text": "AggParamsBucketMin" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsBucketMin.customMetric", "type": "Object", "label": "customMetric", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_min.ts#L18" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] }, { "tags": [], "id": "def-common.AggParamsBucketMin.customBucket", "type": "Object", "label": "customBucket", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_min.ts#L19" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_min.ts#L17" }, "initialIsOpen": false }, { "id": "def-common.AggParamsBucketSum", "type": "Interface", "label": "AggParamsBucketSum", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsBucketSum", "text": "AggParamsBucketSum" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsBucketSum.customMetric", "type": "Object", "label": "customMetric", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_sum.ts#L18" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] }, { "tags": [], "id": "def-common.AggParamsBucketSum.customBucket", "type": "Object", "label": "customBucket", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_sum.ts#L19" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_sum.ts#L17" }, "initialIsOpen": false }, { "id": "def-common.AggParamsCardinality", "type": "Interface", "label": "AggParamsCardinality", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsCardinality", "text": "AggParamsCardinality" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsCardinality.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/cardinality.ts#L21" } } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/cardinality.ts#L20" }, "initialIsOpen": false }, { "id": "def-common.AggParamsCumulativeSum", "type": "Interface", "label": "AggParamsCumulativeSum", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsCumulativeSum", "text": "AggParamsCumulativeSum" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsCumulativeSum.buckets_path", "type": "string", "label": "buckets_path", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L18" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsCumulativeSum.customMetric", "type": "Object", "label": "customMetric", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L19" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] }, { "tags": [], "id": "def-common.AggParamsCumulativeSum.metricAgg", "type": "string", "label": "metricAgg", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L20" }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L17" }, "initialIsOpen": false }, { "id": "def-common.AggParamsDerivative", "type": "Interface", "label": "AggParamsDerivative", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsDerivative", "text": "AggParamsDerivative" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsDerivative.buckets_path", "type": "string", "label": "buckets_path", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/derivative.ts#L18" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDerivative.customMetric", "type": "Object", "label": "customMetric", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/derivative.ts#L19" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] }, { "tags": [], "id": "def-common.AggParamsDerivative.metricAgg", "type": "string", "label": "metricAgg", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/derivative.ts#L20" }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/derivative.ts#L17" }, "initialIsOpen": false }, { "id": "def-common.AggParamsGeoBounds", "type": "Interface", "label": "AggParamsGeoBounds", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsGeoBounds", "text": "AggParamsGeoBounds" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsGeoBounds.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/geo_bounds.ts#L17" } } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/geo_bounds.ts#L16" }, "initialIsOpen": false }, { "id": "def-common.AggParamsGeoCentroid", "type": "Interface", "label": "AggParamsGeoCentroid", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsGeoCentroid", "text": "AggParamsGeoCentroid" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsGeoCentroid.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/geo_centroid.ts#L17" } } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/geo_centroid.ts#L16" }, "initialIsOpen": false }, { "id": "def-common.AggParamsMax", "type": "Interface", "label": "AggParamsMax", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsMax", "text": "AggParamsMax" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsMax.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/max.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/max.ts#L21" } } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/max.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/max.ts#L20" }, "initialIsOpen": false }, { "id": "def-common.AggParamsMedian", "type": "Interface", "label": "AggParamsMedian", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsMedian", "text": "AggParamsMedian" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsMedian.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/median.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/median.ts#L21" } } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/median.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/median.ts#L20" }, "initialIsOpen": false }, { "id": "def-common.IMetricAggConfig", "type": "Interface", "label": "IMetricAggConfig", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.IMetricAggConfig.type", "type": "Object", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L17" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L16" }, "initialIsOpen": false }, { "id": "def-common.MetricAggParam", "type": "Interface", "label": "MetricAggParam", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggParam", "text": "MetricAggParam" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamType", "text": "AggParamType" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.MetricAggParam.filterFieldTypes", "type": "CompoundType", "label": "filterFieldTypes", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L22" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, " | \"*\" | ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, "[] | undefined" ] }, { "tags": [], "id": "def-common.MetricAggParam.onlyAggregatable", "type": "CompoundType", "label": "onlyAggregatable", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L23" }, "signature": [ "boolean | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L20" }, "initialIsOpen": false }, { "id": "def-common.AggParamsMin", "type": "Interface", "label": "AggParamsMin", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsMin", "text": "AggParamsMin" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsMin.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/min.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/min.ts#L21" } } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/min.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/min.ts#L20" }, "initialIsOpen": false }, { "id": "def-common.AggParamsMovingAvg", "type": "Interface", "label": "AggParamsMovingAvg", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsMovingAvg", "text": "AggParamsMovingAvg" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsMovingAvg.buckets_path", "type": "string", "label": "buckets_path", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L18" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsMovingAvg.window", "type": "number", "label": "window", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L19" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.AggParamsMovingAvg.script", "type": "string", "label": "script", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L20" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsMovingAvg.customMetric", "type": "Object", "label": "customMetric", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L21" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] }, { "tags": [], "id": "def-common.AggParamsMovingAvg.metricAgg", "type": "string", "label": "metricAgg", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L22" }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L17" }, "initialIsOpen": false }, { "id": "def-common.AggParamsPercentileRanks", "type": "Interface", "label": "AggParamsPercentileRanks", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsPercentileRanks", "text": "AggParamsPercentileRanks" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsPercentileRanks.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L22" } }, { "tags": [], "id": "def-common.AggParamsPercentileRanks.values", "type": "Array", "label": "values", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L23" }, "signature": [ "number[] | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L21" }, "initialIsOpen": false }, { "id": "def-common.PercentileRanksMetricAggDependencies", "type": "Interface", "label": "PercentileRanksMetricAggDependencies", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.PercentileRanksMetricAggDependencies.getFieldFormatsStart", "type": "Function", "label": "getFieldFormatsStart", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L30" }, "signature": [ "() => Pick, \"deserialize\" | \"getDefaultInstance\">" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L29" }, "initialIsOpen": false }, { "id": "def-common.AggParamsPercentiles", "type": "Interface", "label": "AggParamsPercentiles", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsPercentiles", "text": "AggParamsPercentiles" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsPercentiles.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L20" } }, { "tags": [], "id": "def-common.AggParamsPercentiles.percents", "type": "Array", "label": "percents", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L21" }, "signature": [ "number[] | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L19" }, "initialIsOpen": false }, { "id": "def-common.AggParamsSerialDiff", "type": "Interface", "label": "AggParamsSerialDiff", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsSerialDiff", "text": "AggParamsSerialDiff" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsSerialDiff.buckets_path", "type": "string", "label": "buckets_path", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L18" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsSerialDiff.customMetric", "type": "Object", "label": "customMetric", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L19" }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, " | undefined; schema?: string | undefined; } | undefined" ] }, { "tags": [], "id": "def-common.AggParamsSerialDiff.metricAgg", "type": "string", "label": "metricAgg", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L20" }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L17" }, "initialIsOpen": false }, { "id": "def-common.AggParamsStdDeviation", "type": "Interface", "label": "AggParamsStdDeviation", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsStdDeviation", "text": "AggParamsStdDeviation" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsStdDeviation.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L19" } } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L18" }, "initialIsOpen": false }, { "id": "def-common.IStdDevAggConfig", "type": "Interface", "label": "IStdDevAggConfig", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IStdDevAggConfig", "text": "IStdDevAggConfig" }, " extends ", "IResponseAggConfig" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.IStdDevAggConfig.keyedDetails", "type": "Function", "label": "keyedDetails", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L28" }, "signature": [ "(customLabel: string, fieldDisplayName?: string | undefined) => Record" ] }, { "tags": [], "id": "def-common.IStdDevAggConfig.valProp", "type": "Function", "label": "valProp", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L29" }, "signature": [ "() => string[]" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L27" }, "initialIsOpen": false }, { "id": "def-common.AggParamsSum", "type": "Interface", "label": "AggParamsSum", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsSum", "text": "AggParamsSum" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsSum.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/sum.ts#L21" } } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/sum.ts#L20" }, "initialIsOpen": false }, { "id": "def-common.AggParamsTopHit", "type": "Interface", "label": "AggParamsTopHit", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsTopHit", "text": "AggParamsTopHit" }, " extends ", "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamsTopHit.field", "type": "string", "label": "field", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L18" } }, { "tags": [], "id": "def-common.AggParamsTopHit.aggregate", "type": "CompoundType", "label": "aggregate", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L19" }, "signature": [ "\"max\" | \"min\" | \"concat\" | \"sum\" | \"average\"" ] }, { "tags": [], "id": "def-common.AggParamsTopHit.sortField", "type": "string", "label": "sortField", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L20" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.AggParamsTopHit.size", "type": "number", "label": "size", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L21" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.AggParamsTopHit.sortOrder", "type": "CompoundType", "label": "sortOrder", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L22" }, "signature": [ "\"asc\" | \"desc\" | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L17" }, "initialIsOpen": false }, { "id": "def-common.OptionedValueProp", "type": "Interface", "label": "OptionedValueProp", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.OptionedValueProp.value", "type": "string", "label": "value", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/optioned.ts#L13" } }, { "tags": [], "id": "def-common.OptionedValueProp.text", "type": "string", "label": "text", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/optioned.ts#L14" } }, { "tags": [], "id": "def-common.OptionedValueProp.disabled", "type": "CompoundType", "label": "disabled", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/optioned.ts#L15" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.OptionedValueProp.isCompatible", "type": "Function", "label": "isCompatible", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/optioned.ts#L16" }, "signature": [ "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => boolean" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/optioned.ts#L12" }, "initialIsOpen": false }, { "id": "def-common.AggParamOption", "type": "Interface", "label": "AggParamOption", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.AggParamOption.val", "type": "string", "label": "val", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_params.ts#L31" } }, { "tags": [], "id": "def-common.AggParamOption.display", "type": "string", "label": "display", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_params.ts#L32" } }, { "id": "def-common.AggParamOption.enabled", "type": "Function", "label": "enabled", "signature": [ "((agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => boolean) | undefined" ], "description": [], "children": [ { "type": "Object", "label": "agg", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_params.ts#L33" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_params.ts#L33" } } ], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_params.ts#L30" }, "initialIsOpen": false }, { "id": "def-common.AggFunctionsMapping", "type": "Interface", "label": "AggFunctionsMapping", "description": [ "\nA global list of the expression function definitions for each agg type function." ], "tags": [], "children": [ { "tags": [], "id": "def-common.AggFunctionsMapping.aggFilter", "type": "Object", "label": "aggFilter", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 204, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L204" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggFilters", "type": "Object", "label": "aggFilters", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 205, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L205" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggSignificantTerms", "type": "Object", "label": "aggSignificantTerms", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 206, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L206" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggIpRange", "type": "Object", "label": "aggIpRange", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 207, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L207" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggDateRange", "type": "Object", "label": "aggDateRange", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 208, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L208" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggRange", "type": "Object", "label": "aggRange", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 209, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L209" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggGeoTile", "type": "Object", "label": "aggGeoTile", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 210, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L210" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggGeoHash", "type": "Object", "label": "aggGeoHash", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 211, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L211" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggHistogram", "type": "Object", "label": "aggHistogram", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 212, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L212" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggDateHistogram", "type": "Object", "label": "aggDateHistogram", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 213, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L213" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggTerms", "type": "Object", "label": "aggTerms", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 214, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L214" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggAvg", "type": "Object", "label": "aggAvg", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 215, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L215" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggBucketAvg", "type": "Object", "label": "aggBucketAvg", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 216, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L216" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggBucketMax", "type": "Object", "label": "aggBucketMax", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 217, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L217" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggBucketMin", "type": "Object", "label": "aggBucketMin", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 218, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L218" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggBucketSum", "type": "Object", "label": "aggBucketSum", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 219, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L219" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggCardinality", "type": "Object", "label": "aggCardinality", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 220, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L220" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggCount", "type": "Object", "label": "aggCount", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 221, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L221" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggCumulativeSum", "type": "Object", "label": "aggCumulativeSum", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 222, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L222" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggDerivative", "type": "Object", "label": "aggDerivative", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 223, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L223" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggGeoBounds", "type": "Object", "label": "aggGeoBounds", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 224, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L224" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggGeoCentroid", "type": "Object", "label": "aggGeoCentroid", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 225, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L225" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggMax", "type": "Object", "label": "aggMax", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 226, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L226" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggMedian", "type": "Object", "label": "aggMedian", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 227, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L227" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggMin", "type": "Object", "label": "aggMin", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 228, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L228" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggMovingAvg", "type": "Object", "label": "aggMovingAvg", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 229, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L229" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggPercentileRanks", "type": "Object", "label": "aggPercentileRanks", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 230, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L230" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggPercentiles", "type": "Object", "label": "aggPercentiles", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 231, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L231" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggSerialDiff", "type": "Object", "label": "aggSerialDiff", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 232, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L232" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggStdDeviation", "type": "Object", "label": "aggStdDeviation", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 233, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L233" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggSum", "type": "Object", "label": "aggSum", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 234, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L234" }, "signature": [ "FunctionDefinition" ] }, { "tags": [], "id": "def-common.AggFunctionsMapping.aggTopHit", "type": "Object", "label": "aggTopHit", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 235, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L235" }, "signature": [ "FunctionDefinition" ] } ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 203, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L203" }, "initialIsOpen": false }, { "id": "def-common.IEsSearchRequest", "type": "Interface", "label": "IEsSearchRequest", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchRequest", "text": "IEsSearchRequest" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchRequest", "text": "IKibanaSearchRequest" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchRequestParams", "text": "ISearchRequestParams" }, ">>" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.IEsSearchRequest.indexType", "type": "string", "label": "indexType", "description": [], "source": { "path": "src/plugins/data/common/search/es_search/types.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/es_search/types.ts#L20" }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/es_search/types.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/es_search/types.ts#L19" }, "initialIsOpen": false }, { "id": "def-common.FetchHandlers", "type": "Interface", "label": "FetchHandlers", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.FetchHandlers.getConfig", "type": "Function", "label": "getConfig", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/types.ts#L23" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.GetConfigFn", "text": "GetConfigFn" } ] }, { "tags": [], "id": "def-common.FetchHandlers.onResponse", "type": "Function", "label": "onResponse", "description": [ "\nCallback which can be used to hook into responses, modify them, or perform\nside effects like displaying UI errors on the client." ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/types.ts#L28" }, "signature": [ "(request: Record, response: ", "SearchResponse", ") => ", "SearchResponse", "" ] }, { "tags": [], "id": "def-common.FetchHandlers.legacy", "type": "Object", "label": "legacy", "description": [ "\nThese handlers are only used by the legacy defaultSearchStrategy and can be removed\nonce that strategy has been deprecated." ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/types.ts#L33" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.LegacyFetchHandlers", "text": "LegacyFetchHandlers" } ] } ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/types.ts#L22" }, "initialIsOpen": false }, { "id": "def-common.SearchError", "type": "Interface", "label": "SearchError", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.SearchError.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/types.ts#L37" } }, { "tags": [], "id": "def-common.SearchError.status", "type": "string", "label": "status", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/types.ts#L38" } }, { "tags": [], "id": "def-common.SearchError.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 39, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/types.ts#L39" } }, { "tags": [], "id": "def-common.SearchError.message", "type": "string", "label": "message", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 40, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/types.ts#L40" } }, { "tags": [], "id": "def-common.SearchError.path", "type": "string", "label": "path", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 41, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/types.ts#L41" } }, { "tags": [], "id": "def-common.SearchError.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 42, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/types.ts#L42" } } ], "source": { "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "lineNumber": 36, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/fetch/types.ts#L36" }, "initialIsOpen": false }, { "id": "def-common.MsearchRequestBody", "type": "Interface", "label": "MsearchRequestBody", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.MsearchRequestBody.searches", "type": "Array", "label": "searches", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L26" }, "signature": [ "MsearchRequest[]" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L25" }, "initialIsOpen": false }, { "id": "def-common.MsearchResponse", "type": "Interface", "label": "MsearchResponse", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.MsearchResponse.body", "type": "Object", "label": "body", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L31" }, "signature": [ "ApiResponse", "<{ responses: ", "SearchResponse", "[]; }, ", "Context", ">" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L30" }, "initialIsOpen": false }, { "id": "def-common.LegacyFetchHandlers", "type": "Interface", "label": "LegacyFetchHandlers", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.LegacyFetchHandlers.callMsearch", "type": "Function", "label": "callMsearch", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 36, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L36" }, "signature": [ "(params: { body: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MsearchRequestBody", "text": "MsearchRequestBody" }, "; signal: AbortSignal; }) => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MsearchResponse", "text": "MsearchResponse" }, ">" ] }, { "tags": [], "id": "def-common.LegacyFetchHandlers.loadingCount$", "type": "Object", "label": "loadingCount$", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 40, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L40" }, "signature": [ "BehaviorSubject", "" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L35" }, "initialIsOpen": false }, { "id": "def-common.SearchStrategySearchParams", "type": "Interface", "label": "SearchStrategySearchParams", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchStrategySearchParams", "text": "SearchStrategySearchParams" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FetchHandlers", "text": "FetchHandlers" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.SearchStrategySearchParams.searchRequests", "type": "Array", "label": "searchRequests", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 44, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L44" }, "signature": [ "Record[]" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 43, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L43" }, "initialIsOpen": false }, { "id": "def-common.SearchStrategyProvider", "type": "Interface", "label": "SearchStrategyProvider", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.SearchStrategyProvider.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 49, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L49" } }, { "tags": [], "id": "def-common.SearchStrategyProvider.search", "type": "Function", "label": "search", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 50, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L50" }, "signature": [ "(params: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchStrategySearchParams", "text": "SearchStrategySearchParams" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchStrategyResponse", "text": "SearchStrategyResponse" }, "" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 48, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L48" }, "initialIsOpen": false }, { "id": "def-common.SearchStrategyResponse", "type": "Interface", "label": "SearchStrategyResponse", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchStrategyResponse", "text": "SearchStrategyResponse" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.SearchStrategyResponse.searching", "type": "Object", "label": "searching", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 54, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L54" }, "signature": [ "Promise<", "SearchResponse", "[]>" ] }, { "tags": [], "id": "def-common.SearchStrategyResponse.abort", "type": "Function", "label": "abort", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 55, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L55" }, "signature": [ "() => void" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/legacy/types.ts", "lineNumber": 53, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/legacy/types.ts#L53" }, "initialIsOpen": false }, { "id": "def-common.SearchSourceDependencies", "type": "Interface", "label": "SearchSourceDependencies", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceDependencies", "text": "SearchSourceDependencies" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FetchHandlers", "text": "FetchHandlers" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.SearchSourceDependencies.search", "type": "Function", "label": "search", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 99, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L99" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchGeneric", "text": "ISearchGeneric" } ] } ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", "lineNumber": 98, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/search_source.ts#L98" }, "initialIsOpen": false }, { "id": "def-common.ISearchStartSearchSource", "type": "Interface", "label": "ISearchStartSearchSource", "description": [ "\nhigh level search service" ], "tags": [ "public" ], "children": [ { "tags": [], "id": "def-common.ISearchStartSearchSource.create", "type": "Function", "label": "create", "description": [ "\ncreates {@link SearchSource} based on provided serialized {@link SearchSourceFields}" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L30" }, "signature": [ "(fields?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " | undefined) => Promise>" ] }, { "tags": [], "id": "def-common.ISearchStartSearchSource.createEmpty", "type": "Function", "label": "createEmpty", "description": [ "\ncreates empty {@link SearchSource}" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 34, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L34" }, "signature": [ "() => Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L25" }, "initialIsOpen": false }, { "id": "def-common.SortDirectionNumeric", "type": "Interface", "label": "SortDirectionNumeric", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.SortDirectionNumeric.order", "type": "Enum", "label": "order", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 45, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L45" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SortDirection", "text": "SortDirection" } ] }, { "tags": [], "id": "def-common.SortDirectionNumeric.numeric_type", "type": "CompoundType", "label": "numeric_type", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 46, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L46" }, "signature": [ "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 44, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L44" }, "initialIsOpen": false }, { "id": "def-common.SearchSourceFields", "type": "Interface", "label": "SearchSourceFields", "description": [ "\nsearch source fields" ], "tags": [], "children": [ { "tags": [], "id": "def-common.SearchSourceFields.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 62, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L62" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.query", "type": "Object", "label": "query", "description": [ "\n{@link Query}" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 66, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L66" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.filter", "type": "CompoundType", "label": "filter", "description": [ "\n{@link Filter}" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 70, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L70" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.Filter", "text": "Filter" }, " | ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | (() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.Filter", "text": "Filter" }, " | ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined) | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.sort", "type": "CompoundType", "label": "sort", "description": [ "\n{@link EsQuerySortValue}" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 74, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L74" }, "signature": [ "Record | Record[] | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.highlight", "type": "Any", "label": "highlight", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 75, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L75" }, "signature": [ "any" ] }, { "tags": [], "id": "def-common.SearchSourceFields.highlightAll", "type": "CompoundType", "label": "highlightAll", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 76, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L76" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.trackTotalHits", "type": "CompoundType", "label": "trackTotalHits", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 77, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L77" }, "signature": [ "number | boolean | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.aggs", "type": "Any", "label": "aggs", "description": [ "\n{@link AggConfigs}" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 81, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L81" }, "signature": [ "any" ] }, { "tags": [], "id": "def-common.SearchSourceFields.from", "type": "number", "label": "from", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 82, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L82" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.size", "type": "number", "label": "size", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 83, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L83" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.source", "type": "CompoundType", "label": "source", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 84, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L84" }, "signature": [ "string | boolean | string[] | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.version", "type": "CompoundType", "label": "version", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 85, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L85" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.fields", "type": "Array", "label": "fields", "description": [ "\nRetrieve fields via the search Fields API" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 89, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L89" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchFieldValue", "text": "SearchFieldValue" }, "[] | undefined" ] }, { "tags": [ "deprecated" ], "id": "def-common.SearchSourceFields.fieldsFromSource", "type": "CompoundType", "label": "fieldsFromSource", "description": [ "\nRetreive fields directly from _source (legacy behavior)\n" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 95, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L95" }, "signature": [ "string | boolean | string[] | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.index", "type": "Object", "label": "index", "description": [ "\n{@link IndexPatternService}" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 99, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L99" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.searchAfter", "type": "Object", "label": "searchAfter", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 100, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L100" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.EsQuerySearchAfter", "text": "EsQuerySearchAfter" }, " | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.timeout", "type": "string", "label": "timeout", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 101, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L101" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.terminate_after", "type": "number", "label": "terminate_after", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 102, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L102" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.SearchSourceFields.parent", "type": "Object", "label": "parent", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 104, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L104" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 61, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L61" }, "initialIsOpen": false }, { "id": "def-common.SearchSourceOptions", "type": "Interface", "label": "SearchSourceOptions", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.SearchSourceOptions.callParentStartHandlers", "type": "CompoundType", "label": "callParentStartHandlers", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 108, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L108" }, "signature": [ "boolean | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 107, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L107" }, "initialIsOpen": false }, { "id": "def-common.SortOptions", "type": "Interface", "label": "SortOptions", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.SortOptions.mode", "type": "CompoundType", "label": "mode", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 112, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L112" }, "signature": [ "\"max\" | \"min\" | \"sum\" | \"avg\" | \"median\" | undefined" ] }, { "tags": [], "id": "def-common.SortOptions.type", "type": "CompoundType", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 113, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L113" }, "signature": [ "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" ] }, { "tags": [], "id": "def-common.SortOptions.nested", "type": "Uncategorized", "label": "nested", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 114, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L114" }, "signature": [ "object | undefined" ] }, { "tags": [], "id": "def-common.SortOptions.unmapped_type", "type": "string", "label": "unmapped_type", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 115, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L115" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.SortOptions.distance_type", "type": "CompoundType", "label": "distance_type", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 116, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L116" }, "signature": [ "\"arc\" | \"plane\" | undefined" ] }, { "tags": [], "id": "def-common.SortOptions.unit", "type": "string", "label": "unit", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 117, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L117" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.SortOptions.ignore_unmapped", "type": "CompoundType", "label": "ignore_unmapped", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 118, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L118" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.SortOptions._script", "type": "Uncategorized", "label": "_script", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 119, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L119" }, "signature": [ "object | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 111, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L111" }, "initialIsOpen": false }, { "id": "def-common.Request", "type": "Interface", "label": "Request", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.Request.docvalue_fields", "type": "Array", "label": "docvalue_fields", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 123, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L123" }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.Request._source", "type": "Unknown", "label": "_source", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 124, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L124" }, "signature": [ "unknown" ] }, { "tags": [], "id": "def-common.Request.query", "type": "Unknown", "label": "query", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 125, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L125" }, "signature": [ "unknown" ] }, { "tags": [], "id": "def-common.Request.script_fields", "type": "Unknown", "label": "script_fields", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 126, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L126" }, "signature": [ "unknown" ] }, { "tags": [], "id": "def-common.Request.sort", "type": "Unknown", "label": "sort", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 127, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L127" }, "signature": [ "unknown" ] }, { "tags": [], "id": "def-common.Request.stored_fields", "type": "Array", "label": "stored_fields", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 128, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L128" }, "signature": [ "string[]" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 122, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L122" }, "initialIsOpen": false }, { "id": "def-common.ResponseWithShardFailure", "type": "Interface", "label": "ResponseWithShardFailure", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.ResponseWithShardFailure._shards", "type": "Object", "label": "_shards", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 132, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L132" }, "signature": [ "{ failed: number; failures: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ShardFailure", "text": "ShardFailure" }, "[]; skipped: number; successful: number; total: number; }" ] } ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 131, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L131" }, "initialIsOpen": false }, { "id": "def-common.ShardFailure", "type": "Interface", "label": "ShardFailure", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.ShardFailure.index", "type": "string", "label": "index", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 142, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L142" } }, { "tags": [], "id": "def-common.ShardFailure.node", "type": "string", "label": "node", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 143, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L143" } }, { "tags": [], "id": "def-common.ShardFailure.reason", "type": "Object", "label": "reason", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 144, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L144" }, "signature": [ "{ caused_by: { reason: string; type: string; }; reason: string; lang?: string | undefined; script?: string | undefined; script_stack?: string[] | undefined; type: string; }" ] }, { "tags": [], "id": "def-common.ShardFailure.shard", "type": "number", "label": "shard", "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 155, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L155" } } ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 141, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L141" }, "initialIsOpen": false }, { "id": "def-common.ISearchClient", "type": "Interface", "label": "ISearchClient", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.ISearchClient.search", "type": "Function", "label": "search", "description": [], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L29" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchGeneric", "text": "ISearchGeneric" } ] }, { "tags": [], "id": "def-common.ISearchClient.cancel", "type": "Function", "label": "cancel", "description": [ "\nUsed to cancel an in-progress search request." ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L33" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchCancelGeneric", "text": "ISearchCancelGeneric" } ] }, { "tags": [], "id": "def-common.ISearchClient.extend", "type": "Function", "label": "extend", "description": [ "\nUsed to extend the TTL of an in-progress search request." ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L37" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchExtendGeneric", "text": "ISearchExtendGeneric" } ] } ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L28" }, "initialIsOpen": false }, { "id": "def-common.IKibanaSearchResponse", "type": "Interface", "label": "IKibanaSearchResponse", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.IKibanaSearchResponse.id", "type": "string", "label": "id", "description": [ "\nSome responses may contain a unique id to identify the request this response came from." ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 44, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L44" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.IKibanaSearchResponse.total", "type": "number", "label": "total", "description": [ "\nIf relevant to the search strategy, return a total number\nthat represents how progress is indicated." ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 50, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L50" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.IKibanaSearchResponse.loaded", "type": "number", "label": "loaded", "description": [ "\nIf relevant to the search strategy, return a loaded number\nthat represents how progress is indicated." ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 56, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L56" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.IKibanaSearchResponse.isRunning", "type": "CompoundType", "label": "isRunning", "description": [ "\nIndicates whether search is still in flight" ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 61, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L61" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.IKibanaSearchResponse.isPartial", "type": "CompoundType", "label": "isPartial", "description": [ "\nIndicates whether the results returned are complete or partial" ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 66, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L66" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.IKibanaSearchResponse.rawResponse", "type": "Uncategorized", "label": "rawResponse", "description": [ "\nThe raw response returned by the internal search method (usually the raw ES response)" ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 71, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L71" }, "signature": [ "RawResponse" ] } ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 40, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L40" }, "initialIsOpen": false }, { "id": "def-common.IKibanaSearchRequest", "type": "Interface", "label": "IKibanaSearchRequest", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchRequest", "text": "IKibanaSearchRequest" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.IKibanaSearchRequest.id", "type": "string", "label": "id", "description": [ "\nAn id can be used to uniquely identify this request." ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 78, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L78" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.IKibanaSearchRequest.params", "type": "Uncategorized", "label": "params", "description": [], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 80, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L80" }, "signature": [ "Params | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 74, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L74" }, "initialIsOpen": false }, { "id": "def-common.ISearchOptions", "type": "Interface", "label": "ISearchOptions", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.ISearchOptions.abortSignal", "type": "Object", "label": "abortSignal", "description": [ "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 87, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L87" }, "signature": [ "AbortSignal | undefined" ] }, { "tags": [], "id": "def-common.ISearchOptions.strategy", "type": "string", "label": "strategy", "description": [ "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 92, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L92" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.ISearchOptions.legacyHitsTotal", "type": "CompoundType", "label": "legacyHitsTotal", "description": [ "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 98, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L98" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.ISearchOptions.sessionId", "type": "string", "label": "sessionId", "description": [ "\nA session ID, grouping multiple search requests into a single session." ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 103, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L103" }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.ISearchOptions.isStored", "type": "CompoundType", "label": "isStored", "description": [ "\nWhether the session is already saved (i.e. sent to background)" ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 108, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L108" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.ISearchOptions.isRestore", "type": "CompoundType", "label": "isRestore", "description": [ "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 114, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L114" }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-common.ISearchOptions.indexPattern", "type": "Object", "label": "indexPattern", "description": [ "\nIndex pattern reference is used for better error messages" ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 120, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L120" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined" ] } ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 83, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L83" }, "initialIsOpen": false } ], "enums": [ { "id": "def-common.BUCKET_TYPES", "type": "Enum", "label": "BUCKET_TYPES", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts", "lineNumber": 9, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts#L9" }, "initialIsOpen": false }, { "id": "def-common.IP_RANGE_TYPES", "type": "Enum", "label": "IP_RANGE_TYPES", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L24" }, "initialIsOpen": false }, { "id": "def-common.METRIC_TYPES", "type": "Enum", "label": "METRIC_TYPES", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", "lineNumber": 9, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_types.ts#L9" }, "initialIsOpen": false }, { "id": "def-common.SortDirection", "type": "Enum", "label": "SortDirection", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 39, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L39" }, "initialIsOpen": false } ], "misc": [ { "id": "def-common.AggConfigOptions", "type": "Type", "label": "AggConfigOptions", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 43, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L43" }, "signature": [ "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" ], "initialIsOpen": false }, { "id": "def-common.IAggConfig", "type": "Type", "label": "IAggConfig", "tags": [ "name", "description" ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", "lineNumber": 53, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_config.ts#L53" }, "signature": [ "AggConfig" ], "initialIsOpen": false }, { "id": "def-common.CreateAggConfigParams", "type": "Type", "label": "CreateAggConfigParams", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "lineNumber": 41, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_configs.ts#L41" }, "signature": [ "{ type: string | IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", "SerializableState", " | undefined; }" ], "initialIsOpen": false }, { "id": "def-common.AggGroupName", "type": "Type", "label": "AggGroupName", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_groups.ts#L18" }, "signature": [ "\"buckets\" | \"metrics\" | \"none\"" ], "initialIsOpen": false }, { "id": "def-common.IAggType", "type": "Type", "label": "IAggType", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_type.ts", "lineNumber": 58, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_type.ts#L58" }, "signature": [ "AggType>" ], "initialIsOpen": false }, { "id": "def-common.AggTypesRegistrySetup", "type": "Type", "label": "AggTypesRegistrySetup", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_types_registry.ts#L13" }, "signature": [ "{ registerBucket: (name: N, type: T) => void; registerMetric: (name: N, type: T) => void; }" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.autoInterval", "type": "string", "label": "autoInterval", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/_interval_options.ts#L12" }, "signature": [ "\"auto\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.intervalOptions", "type": "Array", "label": "intervalOptions", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/_interval_options.ts#L15" }, "signature": [ "({ display: string; val: string; enabled(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, "): boolean | \"\" | undefined; } | { display: string; val: string; })[]" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggDateHistogramFnName", "type": "string", "label": "aggDateHistogramFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts#L15" }, "signature": [ "\"aggDateHistogram\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggDateRangeFnName", "type": "string", "label": "aggDateRangeFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/date_range_fn.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/date_range_fn.ts#L15" }, "signature": [ "\"aggDateRange\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggFilterFnName", "type": "string", "label": "aggFilterFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filter_fn.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filter_fn.ts#L15" }, "signature": [ "\"aggFilter\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggFiltersFnName", "type": "string", "label": "aggFiltersFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/filters_fn.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/filters_fn.ts#L15" }, "signature": [ "\"aggFilters\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggGeoHashFnName", "type": "string", "label": "aggGeoHashFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts#L15" }, "signature": [ "\"aggGeoHash\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggGeoTileFnName", "type": "string", "label": "aggGeoTileFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts#L13" }, "signature": [ "\"aggGeoTile\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggHistogramFnName", "type": "string", "label": "aggHistogramFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/histogram_fn.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/histogram_fn.ts#L15" }, "signature": [ "\"aggHistogram\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggIpRangeFnName", "type": "string", "label": "aggIpRangeFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/ip_range_fn.ts#L15" }, "signature": [ "\"aggIpRange\"" ], "initialIsOpen": false }, { "id": "def-common.IpRangeKey", "type": "Type", "label": "IpRangeKey", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L20" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.CidrMaskIpRangeAggKey", "text": "CidrMaskIpRangeAggKey" }, " | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.RangeIpRangeAggKey", "text": "RangeIpRangeAggKey" } ], "initialIsOpen": false }, { "tags": [], "id": "def-common.boundsDescendingRaw", "type": "Array", "label": "boundsDescendingRaw", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L12" }, "signature": [ "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggRangeFnName", "type": "string", "label": "aggRangeFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/range_fn.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/range_fn.ts#L15" }, "signature": [ "\"aggRange\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggSignificantTermsFnName", "type": "string", "label": "aggSignificantTermsFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts#L13" }, "signature": [ "\"aggSignificantTerms\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggTermsFnName", "type": "string", "label": "aggTermsFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms_fn.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms_fn.ts#L14" }, "signature": [ "\"aggTerms\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.termsAggFilter", "type": "Array", "label": "termsAggFilter", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/terms.ts#L32" }, "signature": [ "string[]" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggAvgFnName", "type": "string", "label": "aggAvgFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/avg_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/avg_fn.ts#L13" }, "signature": [ "\"aggAvg\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggBucketAvgFnName", "type": "string", "label": "aggBucketAvgFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts#L14" }, "signature": [ "\"aggBucketAvg\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggBucketMaxFnName", "type": "string", "label": "aggBucketMaxFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts#L14" }, "signature": [ "\"aggBucketMax\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggBucketMinFnName", "type": "string", "label": "aggBucketMinFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts#L14" }, "signature": [ "\"aggBucketMin\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggBucketSumFnName", "type": "string", "label": "aggBucketSumFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts#L14" }, "signature": [ "\"aggBucketSum\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggCardinalityFnName", "type": "string", "label": "aggCardinalityFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/cardinality_fn.ts#L13" }, "signature": [ "\"aggCardinality\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggCountFnName", "type": "string", "label": "aggCountFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/count_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/count_fn.ts#L13" }, "signature": [ "\"aggCount\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggCumulativeSumFnName", "type": "string", "label": "aggCumulativeSumFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts#L14" }, "signature": [ "\"aggCumulativeSum\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggDerivativeFnName", "type": "string", "label": "aggDerivativeFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/derivative_fn.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/derivative_fn.ts#L14" }, "signature": [ "\"aggDerivative\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggGeoBoundsFnName", "type": "string", "label": "aggGeoBoundsFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts#L13" }, "signature": [ "\"aggGeoBounds\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggGeoCentroidFnName", "type": "string", "label": "aggGeoCentroidFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts#L13" }, "signature": [ "\"aggGeoCentroid\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.parentPipelineType", "type": "string", "label": "parentPipelineType", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L26" }, "initialIsOpen": false }, { "tags": [], "id": "def-common.siblingPipelineType", "type": "string", "label": "siblingPipelineType", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L33" }, "initialIsOpen": false }, { "tags": [], "id": "def-common.aggMaxFnName", "type": "string", "label": "aggMaxFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/max_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/max_fn.ts#L13" }, "signature": [ "\"aggMax\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggMedianFnName", "type": "string", "label": "aggMedianFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/median_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/median_fn.ts#L13" }, "signature": [ "\"aggMedian\"" ], "initialIsOpen": false }, { "id": "def-common.IMetricAggType", "type": "Type", "label": "IMetricAggType", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L35" }, "signature": [ "MetricAggType" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggMinFnName", "type": "string", "label": "aggMinFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/min_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/min_fn.ts#L13" }, "signature": [ "\"aggMin\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggMovingAvgFnName", "type": "string", "label": "aggMovingAvgFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts#L14" }, "signature": [ "\"aggMovingAvg\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggPercentileRanksFnName", "type": "string", "label": "aggPercentileRanksFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts#L13" }, "signature": [ "\"aggPercentileRanks\"" ], "initialIsOpen": false }, { "id": "def-common.IPercentileRanksAggConfig", "type": "Type", "label": "IPercentileRanksAggConfig", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L27" }, "signature": [ "IResponseAggConfig" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggPercentilesFnName", "type": "string", "label": "aggPercentilesFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentiles_fn.ts#L13" }, "signature": [ "\"aggPercentiles\"" ], "initialIsOpen": false }, { "id": "def-common.IPercentileAggConfig", "type": "Type", "label": "IPercentileAggConfig", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L24" }, "signature": [ "IResponseAggConfig" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggSerialDiffFnName", "type": "string", "label": "aggSerialDiffFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts#L14" }, "signature": [ "\"aggSerialDiff\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggStdDeviationFnName", "type": "string", "label": "aggStdDeviationFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts#L13" }, "signature": [ "\"aggStdDeviation\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggSumFnName", "type": "string", "label": "aggSumFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/sum_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/sum_fn.ts#L13" }, "signature": [ "\"aggSum\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.aggTopHitFnName", "type": "string", "label": "aggTopHitFnName", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/top_hit_fn.ts#L13" }, "signature": [ "\"aggTopHit\"" ], "initialIsOpen": false }, { "id": "def-common.FieldTypes", "type": "Type", "label": "FieldTypes", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/field.ts#L19" }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, "._SOURCE | ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, ".ATTACHMENT | ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, ".BOOLEAN | ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, ".DATE | ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" } ], "initialIsOpen": false }, { "id": "def-common.IFieldParamType", "type": "Type", "label": "IFieldParamType", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/param_types/field.ts#L21" }, "signature": [ "FieldParamType" ], "initialIsOpen": false }, { "id": "def-common.AggParam", "type": "Type", "label": "AggParam", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_params.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_params.ts#L28" }, "signature": [ "BaseParamType" ], "initialIsOpen": false }, { "id": "def-common.AggsStart", "type": "Type", "label": "AggsStart", "tags": [ "public" ], "description": [ "\nAggsStart represents the actual external contract as AggsCommonStart\nis only used internally. The difference is that AggsStart includes the\ntypings for the registry with initialized agg types.\n" ], "source": { "path": "src/plugins/data/common/search/aggs/types.ts", "lineNumber": 139, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/types.ts#L139" }, "signature": [ "{ calculateAutoTimeExpression: (range: TimeRange) => string | undefined; getDateMetaByDatatableColumn: (column: DatatableColumn) => Promise<{ timeZone: string; timeRange?: TimeRange | undefined; interval: string; } | undefined>; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => AggConfigs; types: AggTypesRegistryStart; }" ], "initialIsOpen": false }, { "id": "def-common.ParsedInterval", "type": "Type", "label": "ParsedInterval", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L18" }, "signature": [ "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.ES_SEARCH_STRATEGY", "type": "string", "label": "ES_SEARCH_STRATEGY", "description": [], "source": { "path": "src/plugins/data/common/search/es_search/types.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/es_search/types.ts#L13" }, "signature": [ "\"es\"" ], "initialIsOpen": false }, { "id": "def-common.ISearchRequestParams", "type": "Type", "label": "ISearchRequestParams", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/es_search/types.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/es_search/types.ts#L15" }, "signature": [ "{ trackTotalHits?: boolean | undefined; } & Search" ], "initialIsOpen": false }, { "id": "def-common.IEsSearchResponse", "type": "Type", "label": "IEsSearchResponse", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/es_search/types.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/es_search/types.ts#L23" }, "signature": [ "IKibanaSearchResponse>" ], "initialIsOpen": false }, { "id": "def-common.ExpressionFunctionKibana", "type": "Type", "label": "ExpressionFunctionKibana", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana.ts#L17" }, "signature": [ "ExpressionFunctionDefinition<\"kibana\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ExecutionContextSearch> | null, object, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>" ], "initialIsOpen": false }, { "id": "def-common.ExpressionFunctionKibanaContext", "type": "Type", "label": "ExpressionFunctionKibanaContext", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L23" }, "signature": [ "ExpressionFunctionDefinition<\"kibana_context\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" ], "initialIsOpen": false }, { "id": "def-common.ExecutionContextSearch", "type": "Type", "label": "ExecutionContextSearch", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context_type.ts#L14" }, "signature": [ "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" ], "initialIsOpen": false }, { "id": "def-common.ExpressionValueSearchContext", "type": "Type", "label": "ExpressionValueSearchContext", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context_type.ts#L20" }, "signature": [ "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "initialIsOpen": false }, { "id": "def-common.KIBANA_CONTEXT_NAME", "type": "Type", "label": "KIBANA_CONTEXT_NAME", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context_type.ts#L26" }, "signature": [ "\"kibana_context\"" ], "initialIsOpen": false }, { "id": "def-common.KibanaContext", "type": "Type", "label": "KibanaContext", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context_type.ts#L27" }, "signature": [ "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "initialIsOpen": false }, { "id": "def-common.EsaggsExpressionFunctionDefinition", "type": "Type", "label": "EsaggsExpressionFunctionDefinition", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L35" }, "signature": [ "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", "SerializableState", ">>" ], "initialIsOpen": false }, { "id": "def-common.ISearchSource", "type": "Type", "label": "ISearchSource", "tags": [ "public" ], "description": [ "\nsearch source interface" ], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L19" }, "signature": [ "{ create: () => SearchSource; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (field: K, value: SearchSourceFields[K]) => SearchSource; removeField: (field: K) => SearchSource; setFields: (newFields: SearchSourceFields) => SearchSource; getId: () => string; getFields: () => SearchSourceFields; getField: (field: K, recurse?: boolean) => SearchSourceFields[K]; getOwnField: (field: K) => SearchSourceFields[K]; createCopy: () => SearchSource; createChild: (options?: {}) => SearchSource; setParent: (parent?: Pick | undefined, options?: SearchSourceOptions) => SearchSource; getParent: () => SearchSource | undefined; fetch$: (options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => ", "Observable", "<", "SearchResponse", ">; fetch: (options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => Promise<", "SearchResponse" ], "initialIsOpen": false }, { "id": "def-common.EsQuerySearchAfter", "type": "Type", "label": "EsQuerySearchAfter", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 37, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L37" }, "signature": [ "[", "ReactText", ", ", "ReactText", "]" ], "initialIsOpen": false }, { "id": "def-common.EsQuerySortValue", "type": "Type", "label": "EsQuerySortValue", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 49, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L49" }, "signature": [ "{ [x: string]: SortDirection | SortDirectionNumeric; }" ], "initialIsOpen": false }, { "id": "def-common.SearchFieldValue", "type": "Type", "label": "SearchFieldValue", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/types.ts", "lineNumber": 56, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/search_source/types.ts#L56" }, "signature": [ "string | SearchField" ], "initialIsOpen": false }, { "id": "def-common.ISearchGeneric", "type": "Type", "label": "ISearchGeneric", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L13" }, "signature": [ "(request: SearchStrategyRequest, options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => ", "Observable", "" ], "initialIsOpen": false }, { "id": "def-common.ISearchCancelGeneric", "type": "Type", "label": "ISearchCancelGeneric", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L21" }, "signature": [ "(id: string, options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise" ], "initialIsOpen": false }, { "id": "def-common.ISearchExtendGeneric", "type": "Type", "label": "ISearchExtendGeneric", "tags": [], "description": [], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L22" }, "signature": [ "(id: string, keepAlive: string, options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise" ], "initialIsOpen": false }, { "id": "def-common.ISearchOptionsSerializable", "type": "Type", "label": "ISearchOptionsSerializable", "tags": [], "description": [ "\nSame as `ISearchOptions`, but contains only serializable fields, which can\nbe sent over the network." ], "source": { "path": "src/plugins/data/common/search/types.ts", "lineNumber": 127, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/types.ts#L127" }, "signature": [ "{ isStored?: boolean | undefined; isRestore?: boolean | undefined; sessionId?: string | undefined; strategy?: string | undefined; legacyHitsTotal?: boolean | undefined; }" ], "initialIsOpen": false } ], "objects": [ { "tags": [], "id": "def-common.AggGroupNames", "type": "Object", "label": "AggGroupNames", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_groups.ts#L12" }, "signature": [ "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" ], "initialIsOpen": false }, { "id": "def-common.AggGroupLabels", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-common.AggGroupLabels.[AggGroupNames.Buckets]", "type": "string", "label": "[AggGroupNames.Buckets]", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_groups.ts#L21" } }, { "tags": [], "id": "def-common.AggGroupLabels.[AggGroupNames.Metrics]", "type": "string", "label": "[AggGroupNames.Metrics]", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_groups.ts#L24" } }, { "tags": [], "id": "def-common.AggGroupLabels.[AggGroupNames.None]", "type": "string", "label": "[AggGroupNames.None]", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_groups.ts#L27" } } ], "description": [], "label": "AggGroupLabels", "source": { "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/agg_groups.ts#L20" }, "initialIsOpen": false }, { "tags": [], "id": "def-common.migrateIncludeExcludeFormat", "type": "Object", "label": "migrateIncludeExcludeFormat", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L25" }, "signature": [ "Partial<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggParam", "text": "BucketAggParam" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">>" ], "initialIsOpen": false }, { "id": "def-common.parentPipelineAggHelper", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-common.parentPipelineAggHelper.subtype", "type": "string", "label": "subtype", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 34, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L34" } }, { "id": "def-common.parentPipelineAggHelper.params", "type": "Function", "label": "params", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggParam", "text": "MetricAggParam" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">[]" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L35" } }, { "id": "def-common.parentPipelineAggHelper.getSerializedFormat", "type": "Function", "label": "getSerializedFormat", "signature": [ "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ") => any" ], "description": [], "children": [ { "type": "Object", "label": "agg", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 63, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L63" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 63, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L63" } } ], "description": [], "label": "parentPipelineAggHelper", "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L33" }, "initialIsOpen": false }, { "id": "def-common.siblingPipelineAggHelper", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-common.siblingPipelineAggHelper.subtype", "type": "string", "label": "subtype", "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 41, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L41" } }, { "id": "def-common.siblingPipelineAggHelper.params", "type": "Function", "label": "params", "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggParam", "text": "MetricAggParam" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">[]" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 42, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L42" } }, { "id": "def-common.siblingPipelineAggHelper.getSerializedFormat", "type": "Function", "label": "getSerializedFormat", "signature": [ "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ") => any" ], "description": [], "children": [ { "type": "Object", "label": "agg", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" } ], "description": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 77, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L77" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 77, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L77" } } ], "description": [], "label": "siblingPipelineAggHelper", "source": { "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "lineNumber": 40, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L40" }, "initialIsOpen": false }, { "id": "def-common.kibana", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-common.kibana.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana.ts#L27" }, "signature": [ "\"kibana\"" ] }, { "tags": [], "id": "def-common.kibana.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana.ts#L28" }, "signature": [ "\"kibana_context\"" ] }, { "tags": [], "id": "def-common.kibana.inputTypes", "type": "Array", "label": "inputTypes", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana.ts#L30" }, "signature": [ "(\"kibana_context\" | \"null\")[]" ] }, { "tags": [], "id": "def-common.kibana.help", "type": "string", "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana.ts#L32" } }, { "id": "def-common.kibana.args", "type": "Object", "tags": [], "children": [], "description": [], "label": "args", "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 36, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana.ts#L36" } }, { "id": "def-common.kibana.fn", "type": "Function", "label": "fn", "signature": [ "(input: Input, _: object, { getSearchContext }: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" } ], "description": [], "children": [ { "type": "CompoundType", "label": "input", "isRequired": false, "signature": [ "Input" ], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana.ts#L38" } }, { "type": "Uncategorized", "label": "_", "isRequired": true, "signature": [ "object" ], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana.ts#L38" } }, { "type": "Object", "label": "{ getSearchContext }", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">" ], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana.ts#L38" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana.ts#L38" } } ], "description": [], "label": "kibana", "source": { "path": "src/plugins/data/common/search/expressions/kibana.ts", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana.ts#L26" }, "initialIsOpen": false }, { "id": "def-common.kibanaContextFunction", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-common.kibanaContextFunction.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 41, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L41" }, "signature": [ "\"kibana_context\"" ] }, { "tags": [], "id": "def-common.kibanaContextFunction.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 42, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L42" }, "signature": [ "\"kibana_context\"" ] }, { "tags": [], "id": "def-common.kibanaContextFunction.inputTypes", "type": "Array", "label": "inputTypes", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 43, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L43" }, "signature": [ "(\"kibana_context\" | \"null\")[]" ] }, { "tags": [], "id": "def-common.kibanaContextFunction.help", "type": "string", "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 44, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L44" } }, { "id": "def-common.kibanaContextFunction.args", "type": "Object", "tags": [], "children": [ { "id": "def-common.kibanaContextFunction.args.q", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-common.kibanaContextFunction.args.q.types", "type": "Array", "label": "types", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 49, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L49" }, "signature": [ "(\"string\" | \"null\")[]" ] }, { "tags": [], "id": "def-common.kibanaContextFunction.args.q.aliases", "type": "Array", "label": "aliases", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 50, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L50" }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.kibanaContextFunction.args.q.default", "type": "Uncategorized", "label": "default", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 51, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L51" }, "signature": [ "null" ] }, { "tags": [], "id": "def-common.kibanaContextFunction.args.q.help", "type": "string", "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 52, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L52" } } ], "description": [], "label": "q", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 48, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L48" } }, { "id": "def-common.kibanaContextFunction.args.filters", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-common.kibanaContextFunction.args.filters.types", "type": "Array", "label": "types", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 57, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L57" }, "signature": [ "(\"string\" | \"null\")[]" ] }, { "tags": [], "id": "def-common.kibanaContextFunction.args.filters.default", "type": "string", "label": "default", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 58, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L58" } }, { "tags": [], "id": "def-common.kibanaContextFunction.args.filters.help", "type": "string", "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 59, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L59" } } ], "description": [], "label": "filters", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 56, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L56" } }, { "id": "def-common.kibanaContextFunction.args.timeRange", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-common.kibanaContextFunction.args.timeRange.types", "type": "Array", "label": "types", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 64, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L64" }, "signature": [ "(\"string\" | \"null\")[]" ] }, { "tags": [], "id": "def-common.kibanaContextFunction.args.timeRange.default", "type": "Uncategorized", "label": "default", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 65, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L65" }, "signature": [ "null" ] }, { "tags": [], "id": "def-common.kibanaContextFunction.args.timeRange.help", "type": "string", "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 66, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L66" } } ], "description": [], "label": "timeRange", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 63, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L63" } }, { "id": "def-common.kibanaContextFunction.args.savedSearchId", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-common.kibanaContextFunction.args.savedSearchId.types", "type": "Array", "label": "types", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 71, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L71" }, "signature": [ "(\"string\" | \"null\")[]" ] }, { "tags": [], "id": "def-common.kibanaContextFunction.args.savedSearchId.default", "type": "Uncategorized", "label": "default", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 72, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L72" }, "signature": [ "null" ] }, { "tags": [], "id": "def-common.kibanaContextFunction.args.savedSearchId.help", "type": "string", "label": "help", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 73, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L73" } } ], "description": [], "label": "savedSearchId", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 70, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L70" } } ], "description": [], "label": "args", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 47, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L47" } }, { "id": "def-common.kibanaContextFunction.fn", "type": "Function", "label": "fn", "signature": [ "(input: Input, args: Arguments, { getSavedObject }: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">) => Promise<{ type: \"kibana_context\"; query: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.Query", "text": "Query" }, "[]; filters: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.Filter", "text": "Filter" } ], "description": [], "children": [ { "type": "CompoundType", "label": "input", "isRequired": false, "signature": [ "Input" ], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 79, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L79" } }, { "type": "Object", "label": "args", "isRequired": true, "signature": [ "Arguments" ], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 79, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L79" } }, { "type": "Object", "label": "{ getSavedObject }", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">" ], "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 79, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L79" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 79, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L79" } } ], "description": [], "label": "kibanaContextFunction", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "lineNumber": 40, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context.ts#L40" }, "initialIsOpen": false }, { "id": "def-common.kibanaContext", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-common.kibanaContext.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context_type.ts#L30" } }, { "id": "def-common.kibanaContext.from", "type": "Object", "tags": [], "children": [ { "id": "def-common.kibanaContext.from.null", "type": "Function", "children": [], "signature": [ "() => { type: string; }" ], "description": [], "label": "null", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context_type.ts#L32" }, "tags": [], "returnComment": [] } ], "description": [], "label": "from", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 31, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context_type.ts#L31" } }, { "id": "def-common.kibanaContext.to", "type": "Object", "tags": [], "children": [ { "id": "def-common.kibanaContext.to.null", "type": "Function", "children": [], "signature": [ "() => { type: string; }" ], "description": [], "label": "null", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 39, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context_type.ts#L39" }, "tags": [], "returnComment": [] } ], "description": [], "label": "to", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 38, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context_type.ts#L38" } } ], "description": [], "label": "kibanaContext", "source": { "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/common/search/expressions/kibana_context_type.ts#L29" }, "initialIsOpen": false } ] } }