{ "id": "discover", "client": { "classes": [], "functions": [ { "parentPluginId": "discover", "id": "def-public.getSavedSearch", "type": "Function", "tags": [], "label": "getSavedSearch", "description": [], "signature": [ "(savedSearchId: string | undefined, dependencies: GetSavedSearchDependencies) => Promise<", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.SavedSearch", "text": "SavedSearch" }, ">" ], "path": "src/plugins/discover/public/saved_searches/get_saved_searches.ts", "deprecated": false, "children": [ { "parentPluginId": "discover", "id": "def-public.getSavedSearch.$1", "type": "string", "tags": [], "label": "savedSearchId", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/saved_searches/get_saved_searches.ts", "deprecated": false, "isRequired": false }, { "parentPluginId": "discover", "id": "def-public.getSavedSearch.$2", "type": "Object", "tags": [], "label": "dependencies", "description": [], "signature": [ "GetSavedSearchDependencies" ], "path": "src/plugins/discover/public/saved_searches/get_saved_searches.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.getSavedSearchFullPathUrl", "type": "Function", "tags": [], "label": "getSavedSearchFullPathUrl", "description": [], "signature": [ "(id?: string | undefined) => string" ], "path": "src/plugins/discover/public/saved_searches/saved_searches_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "discover", "id": "def-public.getSavedSearchFullPathUrl.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/saved_searches/saved_searches_utils.ts", "deprecated": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.getSavedSearchUrl", "type": "Function", "tags": [], "label": "getSavedSearchUrl", "description": [], "signature": [ "(id?: string | undefined) => string" ], "path": "src/plugins/discover/public/saved_searches/saved_searches_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "discover", "id": "def-public.getSavedSearchUrl.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/saved_searches/saved_searches_utils.ts", "deprecated": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.getSavedSearchUrlConflictMessage", "type": "Function", "tags": [], "label": "getSavedSearchUrlConflictMessage", "description": [], "signature": [ "(savedSearch: ", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.SavedSearch", "text": "SavedSearch" }, ") => Promise" ], "path": "src/plugins/discover/public/saved_searches/saved_searches_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "discover", "id": "def-public.getSavedSearchUrlConflictMessage.$1", "type": "Object", "tags": [], "label": "savedSearch", "description": [], "signature": [ { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.SavedSearch", "text": "SavedSearch" } ], "path": "src/plugins/discover/public/saved_searches/saved_searches_utils.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.loadSharingDataHelpers", "type": "Function", "tags": [], "label": "loadSharingDataHelpers", "description": [], "signature": [ "() => Promise" ], "path": "src/plugins/discover/public/shared/index.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.throwErrorOnSavedSearchUrlConflict", "type": "Function", "tags": [], "label": "throwErrorOnSavedSearchUrlConflict", "description": [], "signature": [ "(savedSearch: ", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.SavedSearch", "text": "SavedSearch" }, ") => Promise" ], "path": "src/plugins/discover/public/saved_searches/saved_searches_utils.ts", "deprecated": false, "children": [ { "parentPluginId": "discover", "id": "def-public.throwErrorOnSavedSearchUrlConflict.$1", "type": "Object", "tags": [], "label": "savedSearch", "description": [], "signature": [ { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.SavedSearch", "text": "SavedSearch" } ], "path": "src/plugins/discover/public/saved_searches/saved_searches_utils.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams", "type": "Interface", "tags": [], "label": "DiscoverAppLocatorParams", "description": [], "signature": [ { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" }, " extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" } ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false, "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.savedSearchId", "type": "string", "tags": [], "label": "savedSearchId", "description": [ "\nOptionally set saved search ID." ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.indexPatternId", "type": "string", "tags": [], "label": "indexPatternId", "description": [ "\nOptionally set index pattern ID." ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.timeRange", "type": "Object", "tags": [], "label": "timeRange", "description": [ "\nOptionally set the time range in the time picker." ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.refreshInterval", "type": "CompoundType", "tags": [], "label": "refreshInterval", "description": [ "\nOptionally set the refresh interval." ], "signature": [ "(", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.RefreshInterval", "text": "RefreshInterval" }, " & ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ") | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.filters", "type": "Array", "tags": [], "label": "filters", "description": [ "\nOptionally apply filters." ], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.query", "type": "Object", "tags": [], "label": "query", "description": [ "\nOptionally set a query." ], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.useHash", "type": "CompoundType", "tags": [], "label": "useHash", "description": [ "\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.searchSessionId", "type": "string", "tags": [], "label": "searchSessionId", "description": [ "\nBackground search session id" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.columns", "type": "Array", "tags": [], "label": "columns", "description": [ "\nColumns displayed in the table" ], "signature": [ "string[] | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.interval", "type": "string", "tags": [], "label": "interval", "description": [ "\nUsed interval of the histogram" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.sort", "type": "Array", "tags": [], "label": "sort", "description": [ "\nArray of the used sorting [[field,direction],...]" ], "signature": [ "string[][] | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.savedQuery", "type": "string", "tags": [], "label": "savedQuery", "description": [ "\nid of the used saved query" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState", "type": "Interface", "tags": [], "label": "DiscoverUrlGeneratorState", "description": [], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false, "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.savedSearchId", "type": "string", "tags": [], "label": "savedSearchId", "description": [ "\nOptionally set saved search ID." ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.indexPatternId", "type": "string", "tags": [], "label": "indexPatternId", "description": [ "\nOptionally set index pattern ID." ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.timeRange", "type": "Object", "tags": [], "label": "timeRange", "description": [ "\nOptionally set the time range in the time picker." ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.refreshInterval", "type": "Object", "tags": [], "label": "refreshInterval", "description": [ "\nOptionally set the refresh interval." ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.RefreshInterval", "text": "RefreshInterval" }, " | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.filters", "type": "Array", "tags": [], "label": "filters", "description": [ "\nOptionally apply filters." ], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.query", "type": "Object", "tags": [], "label": "query", "description": [ "\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query." ], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.useHash", "type": "CompoundType", "tags": [], "label": "useHash", "description": [ "\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.searchSessionId", "type": "string", "tags": [], "label": "searchSessionId", "description": [ "\nBackground search session id" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.columns", "type": "Array", "tags": [], "label": "columns", "description": [ "\nColumns displayed in the table" ], "signature": [ "string[] | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.interval", "type": "string", "tags": [], "label": "interval", "description": [ "\nUsed interval of the histogram" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.sort", "type": "Array", "tags": [], "label": "sort", "description": [ "\nArray of the used sorting [[field,direction],...]" ], "signature": [ "string[][] | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.savedQuery", "type": "string", "tags": [], "label": "savedQuery", "description": [ "\nid of the used saved query" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.ISearchEmbeddable", "type": "Interface", "tags": [], "label": "ISearchEmbeddable", "description": [], "signature": [ { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.ISearchEmbeddable", "text": "ISearchEmbeddable" }, " extends ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.SearchInput", "text": "SearchInput" }, ", ", "SearchOutput", ">" ], "path": "src/plugins/discover/public/application/embeddable/types.ts", "deprecated": false, "children": [ { "parentPluginId": "discover", "id": "def-public.ISearchEmbeddable.getSavedSearch", "type": "Function", "tags": [], "label": "getSavedSearch", "description": [], "signature": [ "() => ", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.SavedSearch", "text": "SavedSearch" } ], "path": "src/plugins/discover/public/application/embeddable/types.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.SavedSearch", "type": "Interface", "tags": [], "label": "SavedSearch", "description": [], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false, "children": [ { "parentPluginId": "discover", "id": "def-public.SavedSearch.searchSource", "type": "Object", "tags": [], "label": "searchSource", "description": [], "signature": [ "{ create: () => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, "; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (field: K, value: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, "; removeField: (field: K) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, "; setFields: (newFields: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, "; getId: () => string; getFields: () => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "; getField: (field: K, recurse?: boolean) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]; getOwnField: (field: K) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]; createCopy: () => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, "; createChild: (options?: {}) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, "; setParent: (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" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, "; getParent: () => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, " | undefined; fetch$: (options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => ", "Observable", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "<", "SearchResponse", ">>; fetch: (options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => Promise<", "SearchResponse", ">; onRequestStart: (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; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "; serialize: () => { searchSourceJSON: string; references: ", "SavedObjectReference", "[]; }; }" ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SavedSearch.id", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SavedSearch.title", "type": "string", "tags": [], "label": "title", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SavedSearch.sort", "type": "Array", "tags": [], "label": "sort", "description": [], "signature": [ "SortOrder", "[] | undefined" ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SavedSearch.columns", "type": "Array", "tags": [], "label": "columns", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SavedSearch.description", "type": "string", "tags": [], "label": "description", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SavedSearch.grid", "type": "Object", "tags": [], "label": "grid", "description": [], "signature": [ "{ columns?: Record | undefined; } | undefined" ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SavedSearch.hideChart", "type": "CompoundType", "tags": [], "label": "hideChart", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SavedSearch.sharingSavedObjectProps", "type": "Object", "tags": [], "label": "sharingSavedObjectProps", "description": [], "signature": [ "{ outcome?: \"conflict\" | \"aliasMatch\" | \"exactMatch\" | undefined; aliasTargetId?: string | undefined; errorJSON?: string | undefined; } | undefined" ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SavedSearch.viewMode", "type": "CompoundType", "tags": [], "label": "viewMode", "description": [], "signature": [ "VIEW_MODE", " | undefined" ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SavedSearch.hideAggregatedPreview", "type": "CompoundType", "tags": [], "label": "hideAggregatedPreview", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.SearchInput", "type": "Interface", "tags": [], "label": "SearchInput", "description": [], "signature": [ { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.SearchInput", "text": "SearchInput" }, " extends ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } ], "path": "src/plugins/discover/public/application/embeddable/types.ts", "deprecated": false, "children": [ { "parentPluginId": "discover", "id": "def-public.SearchInput.timeRange", "type": "Object", "tags": [], "label": "timeRange", "description": [], "signature": [ "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" ], "path": "src/plugins/discover/public/application/embeddable/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SearchInput.query", "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | undefined" ], "path": "src/plugins/discover/public/application/embeddable/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SearchInput.filters", "type": "Array", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined" ], "path": "src/plugins/discover/public/application/embeddable/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SearchInput.hidePanelTitles", "type": "CompoundType", "tags": [], "label": "hidePanelTitles", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/discover/public/application/embeddable/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SearchInput.columns", "type": "Array", "tags": [], "label": "columns", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/discover/public/application/embeddable/types.ts", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.SearchInput.sort", "type": "Array", "tags": [], "label": "sort", "description": [], "signature": [ "SortOrder", "[] | undefined" ], "path": "src/plugins/discover/public/application/embeddable/types.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "discover", "id": "def-public.DISCOVER_APP_URL_GENERATOR", "type": "string", "tags": [], "label": "DISCOVER_APP_URL_GENERATOR", "description": [], "signature": [ "\"DISCOVER_APP_URL_GENERATOR\"" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocator", "type": "Type", "tags": [], "label": "DiscoverAppLocator", "description": [], "signature": [ { "pluginId": "share", "scope": "common", "docId": "kibSharePluginApi", "section": "def-common.LocatorPublic", "text": "LocatorPublic" }, "<", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" }, ">" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.SEARCH_EMBEDDABLE_TYPE", "type": "string", "tags": [], "label": "SEARCH_EMBEDDABLE_TYPE", "description": [], "signature": [ "\"search\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "discover", "id": "def-public.DiscoverSetup", "type": "Interface", "tags": [], "label": "DiscoverSetup", "description": [], "path": "src/plugins/discover/public/plugin.tsx", "deprecated": false, "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverSetup.docViews", "type": "Object", "tags": [], "label": "docViews", "description": [], "signature": [ "{ addDocView(docViewRaw: ComponentDocViewInput | ", "RenderDocViewInput", " | ", "DocViewInputFn", "): void; }" ], "path": "src/plugins/discover/public/plugin.tsx", "deprecated": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverSetup.locator", "type": "Object", "tags": [], "label": "locator", "description": [ "\n`share` plugin URL locator for Discover app. Use it to generate links into\nDiscover application, for example, navigate:\n\n```ts\nawait plugins.discover.locator.navigate({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```\n\nGenerate a location:\n\n```ts\nconst location = await plugins.discover.locator.getLocation({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```" ], "signature": [ { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.DiscoverAppLocator", "text": "DiscoverAppLocator" }, " | undefined" ], "path": "src/plugins/discover/public/plugin.tsx", "deprecated": false } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "discover", "id": "def-public.DiscoverStart", "type": "Interface", "tags": [], "label": "DiscoverStart", "description": [], "path": "src/plugins/discover/public/plugin.tsx", "deprecated": false, "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverStart.urlGenerator", "type": "Object", "tags": [ "deprecated" ], "label": "urlGenerator", "description": [], "signature": [ { "pluginId": "share", "scope": "public", "docId": "kibSharePluginApi", "section": "def-public.UrlGeneratorContract", "text": "UrlGeneratorContract" }, "<\"DISCOVER_APP_URL_GENERATOR\"> | undefined" ], "path": "src/plugins/discover/public/plugin.tsx", "deprecated": true, "references": [ { "plugin": "observability", "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_discover_link.tsx" }, { "plugin": "osquery", "path": "x-pack/plugins/osquery/public/packs/pack_queries_status_table.tsx" }, { "plugin": "osquery", "path": "x-pack/plugins/osquery/public/common/hooks/use_discover_link.tsx" } ] }, { "parentPluginId": "discover", "id": "def-public.DiscoverStart.locator", "type": "Object", "tags": [], "label": "locator", "description": [ "\n`share` plugin URL locator for Discover app. Use it to generate links into\nDiscover application, for example, navigate:\n\n```ts\nawait plugins.discover.locator.navigate({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```\n\nGenerate a location:\n\n```ts\nconst location = await plugins.discover.locator.getLocation({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```" ], "signature": [ { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.DiscoverAppLocator", "text": "DiscoverAppLocator" }, " | undefined" ], "path": "src/plugins/discover/public/plugin.tsx", "deprecated": false } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [ { "parentPluginId": "discover", "id": "def-common.CONTEXT_DEFAULT_SIZE_SETTING", "type": "string", "tags": [], "label": "CONTEXT_DEFAULT_SIZE_SETTING", "description": [], "signature": [ "\"context:defaultSize\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.CONTEXT_STEP_SETTING", "type": "string", "tags": [], "label": "CONTEXT_STEP_SETTING", "description": [], "signature": [ "\"context:step\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.CONTEXT_TIE_BREAKER_FIELDS_SETTING", "type": "string", "tags": [], "label": "CONTEXT_TIE_BREAKER_FIELDS_SETTING", "description": [], "signature": [ "\"context:tieBreakerFields\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.DEFAULT_COLUMNS_SETTING", "type": "string", "tags": [], "label": "DEFAULT_COLUMNS_SETTING", "description": [], "signature": [ "\"defaultColumns\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.DOC_HIDE_TIME_COLUMN_SETTING", "type": "string", "tags": [], "label": "DOC_HIDE_TIME_COLUMN_SETTING", "description": [], "signature": [ "\"doc_table:hideTimeColumn\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.DOC_TABLE_LEGACY", "type": "string", "tags": [], "label": "DOC_TABLE_LEGACY", "description": [], "signature": [ "\"doc_table:legacy\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.FIELDS_LIMIT_SETTING", "type": "string", "tags": [], "label": "FIELDS_LIMIT_SETTING", "description": [], "signature": [ "\"fields:popularLimit\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.MAX_DOC_FIELDS_DISPLAYED", "type": "string", "tags": [], "label": "MAX_DOC_FIELDS_DISPLAYED", "description": [], "signature": [ "\"discover:maxDocFieldsDisplayed\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.MODIFY_COLUMNS_ON_SWITCH", "type": "string", "tags": [], "label": "MODIFY_COLUMNS_ON_SWITCH", "description": [], "signature": [ "\"discover:modifyColumnsOnSwitch\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.SAMPLE_SIZE_SETTING", "type": "string", "tags": [], "label": "SAMPLE_SIZE_SETTING", "description": [], "signature": [ "\"discover:sampleSize\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.SEARCH_EMBEDDABLE_TYPE", "type": "string", "tags": [], "label": "SEARCH_EMBEDDABLE_TYPE", "description": [], "signature": [ "\"search\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.SEARCH_FIELDS_FROM_SOURCE", "type": "string", "tags": [], "label": "SEARCH_FIELDS_FROM_SOURCE", "description": [], "signature": [ "\"discover:searchFieldsFromSource\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.SEARCH_ON_PAGE_LOAD_SETTING", "type": "string", "tags": [], "label": "SEARCH_ON_PAGE_LOAD_SETTING", "description": [], "signature": [ "\"discover:searchOnPageLoad\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.SHOW_FIELD_STATISTICS", "type": "string", "tags": [], "label": "SHOW_FIELD_STATISTICS", "description": [], "signature": [ "\"discover:showFieldStatistics\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.SHOW_MULTIFIELDS", "type": "string", "tags": [], "label": "SHOW_MULTIFIELDS", "description": [], "signature": [ "\"discover:showMultiFields\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.SORT_DEFAULT_ORDER_SETTING", "type": "string", "tags": [], "label": "SORT_DEFAULT_ORDER_SETTING", "description": [], "signature": [ "\"discover:sort:defaultOrder\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [] } }