{ "id": "discover", "client": { "classes": [], "functions": [ { "parentPluginId": "discover", "id": "def-public.loadSharingDataHelpers", "type": "Function", "tags": [], "label": "loadSharingDataHelpers", "description": [], "signature": [ "() => Promise" ], "path": "src/plugins/discover/public/utils/index.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "discover", "id": "def-public.DiscoverAppState", "type": "Interface", "tags": [], "label": "DiscoverAppState", "description": [], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.columns", "type": "Array", "tags": [], "label": "columns", "description": [ "\nColumns displayed in the table" ], "signature": [ "string[] | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.filters", "type": "Array", "tags": [], "label": "filters", "description": [ "\nArray of applied filters" ], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.grid", "type": "Object", "tags": [], "label": "grid", "description": [ "\nData Grid related state" ], "signature": [ { "pluginId": "@kbn/unified-data-table", "scope": "common", "docId": "kibKbnUnifiedDataTablePluginApi", "section": "def-common.UnifiedDataTableSettings", "text": "UnifiedDataTableSettings" }, " | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.hideChart", "type": "CompoundType", "tags": [], "label": "hideChart", "description": [ "\nHide chart" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.index", "type": "string", "tags": [], "label": "index", "description": [ "\nid of the used data view" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.interval", "type": "string", "tags": [], "label": "interval", "description": [ "\nUsed interval of the histogram" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.query", "type": "CompoundType", "tags": [], "label": "query", "description": [ "\nLucence or KQL query" ], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, " | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.sort", "type": "Array", "tags": [], "label": "sort", "description": [ "\nArray of the used sorting [[field,direction],...]" ], "signature": [ "string[][] | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.savedQuery", "type": "string", "tags": [], "label": "savedQuery", "description": [ "\nid of the used saved query" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.viewMode", "type": "CompoundType", "tags": [], "label": "viewMode", "description": [ "\nTable view: Documents vs Field Statistics" ], "signature": [ { "pluginId": "savedSearch", "scope": "common", "docId": "kibSavedSearchPluginApi", "section": "def-common.VIEW_MODE", "text": "VIEW_MODE" }, " | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.hideAggregatedPreview", "type": "CompoundType", "tags": [], "label": "hideAggregatedPreview", "description": [ "\nHide mini distribution/preview charts when in Field Statistics mode" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.rowHeight", "type": "number", "tags": [], "label": "rowHeight", "description": [ "\nDocument explorer row height option" ], "signature": [ "number | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.rowsPerPage", "type": "number", "tags": [], "label": "rowsPerPage", "description": [ "\nNumber of rows in the grid per page" ], "signature": [ "number | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverAppState.breakdownField", "type": "string", "tags": [], "label": "breakdownField", "description": [ "\nBreakdown field of chart" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverCustomizationService", "type": "Interface", "tags": [], "label": "DiscoverCustomizationService", "description": [], "path": "src/plugins/discover/public/customizations/customization_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverCustomizationService.set", "type": "Function", "tags": [], "label": "set", "description": [], "signature": [ "(customization: ", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.DiscoverCustomization", "text": "DiscoverCustomization" }, ") => void" ], "path": "src/plugins/discover/public/customizations/customization_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverCustomizationService.set.$1", "type": "CompoundType", "tags": [], "label": "customization", "description": [], "signature": [ { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.DiscoverCustomization", "text": "DiscoverCustomization" } ], "path": "src/plugins/discover/public/customizations/customization_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "discover", "id": "def-public.DiscoverCustomizationService.get$", "type": "Function", "tags": [], "label": "get$", "description": [], "signature": [ "(id: TCustomizationId) => ", "Observable", " | Extract<", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.SearchBarCustomization", "text": "SearchBarCustomization" }, ", { id: TCustomizationId; }> | Extract<", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.TopNavCustomization", "text": "TopNavCustomization" }, ", { id: TCustomizationId; }> | Extract<", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.UnifiedHistogramCustomization", "text": "UnifiedHistogramCustomization" }, ", { id: TCustomizationId; }> | undefined>" ], "path": "src/plugins/discover/public/customizations/customization_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverCustomizationService.get$.$1", "type": "Uncategorized", "tags": [], "label": "id", "description": [], "signature": [ "TCustomizationId" ], "path": "src/plugins/discover/public/customizations/customization_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "discover", "id": "def-public.DiscoverCustomizationService.enable", "type": "Function", "tags": [], "label": "enable", "description": [], "signature": [ "(id: \"flyout\" | \"search_bar\" | \"top_nav\" | \"unified_histogram\") => void" ], "path": "src/plugins/discover/public/customizations/customization_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverCustomizationService.enable.$1", "type": "CompoundType", "tags": [], "label": "id", "description": [], "signature": [ "\"flyout\" | \"search_bar\" | \"top_nav\" | \"unified_histogram\"" ], "path": "src/plugins/discover/public/customizations/customization_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "discover", "id": "def-public.DiscoverCustomizationService.disable", "type": "Function", "tags": [], "label": "disable", "description": [], "signature": [ "(id: \"flyout\" | \"search_bar\" | \"top_nav\" | \"unified_histogram\") => void" ], "path": "src/plugins/discover/public/customizations/customization_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverCustomizationService.disable.$1", "type": "CompoundType", "tags": [], "label": "id", "description": [], "signature": [ "\"flyout\" | \"search_bar\" | \"top_nav\" | \"unified_histogram\"" ], "path": "src/plugins/discover/public/customizations/customization_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverProfileOptions", "type": "Interface", "tags": [], "label": "DiscoverProfileOptions", "description": [], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverProfileOptions.customize", "type": "Function", "tags": [], "label": "customize", "description": [], "signature": [ "(options: ", "CustomizationCallbackContext", ") => void | (() => void) | Promise void)>" ], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverProfileOptions.customize.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "CustomizationCallbackContext" ], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "discover", "id": "def-public.DiscoverProfileOptions.deepLinks", "type": "Array", "tags": [], "label": "deepLinks", "description": [], "signature": [ { "pluginId": "@kbn/core-application-browser", "scope": "common", "docId": "kibKbnCoreApplicationBrowserPluginApi", "section": "def-common.AppDeepLink", "text": "AppDeepLink" }, "[] | undefined" ], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverStateContainer", "type": "Interface", "tags": [], "label": "DiscoverStateContainer", "description": [], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverStateContainer.globalState", "type": "Object", "tags": [], "label": "globalState", "description": [ "\nGlobal State, the _g part of the URL" ], "signature": [ "DiscoverGlobalStateContainer" ], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverStateContainer.appState", "type": "Object", "tags": [], "label": "appState", "description": [ "\nApp state, the _a part of the URL" ], "signature": [ "DiscoverAppStateContainer" ], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverStateContainer.dataState", "type": "Object", "tags": [], "label": "dataState", "description": [ "\nData fetching related state" ], "signature": [ "DiscoverDataStateContainer" ], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverStateContainer.internalState", "type": "Object", "tags": [], "label": "internalState", "description": [ "\nInternal shared state that's used at several places in the UI" ], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.ReduxLikeStateContainer", "text": "ReduxLikeStateContainer" }, "<", "InternalState", ", InternalStateTransitions, {}>" ], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverStateContainer.savedSearchState", "type": "Object", "tags": [], "label": "savedSearchState", "description": [ "\nState of saved search, the saved object of Discover" ], "signature": [ "DiscoverSavedSearchContainer" ], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverStateContainer.stateStorage", "type": "Object", "tags": [], "label": "stateStorage", "description": [ "\nState of url, allows updating and subscribing to url changes" ], "signature": [ { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.IKbnUrlStateStorage", "text": "IKbnUrlStateStorage" } ], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverStateContainer.searchSessionManager", "type": "Object", "tags": [], "label": "searchSessionManager", "description": [ "\nService for handling search sessions" ], "signature": [ "DiscoverSearchSessionManager" ], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverStateContainer.actions", "type": "Object", "tags": [], "label": "actions", "description": [ "\nComplex functions to update multiple containers from UI" ], "signature": [ "{ fetchData: (initial?: boolean | undefined) => void; initializeAndSync: () => () => void; loadDataViewList: () => Promise; loadSavedSearch: (param?: ", "LoadParams", " | undefined) => Promise<", { "pluginId": "savedSearch", "scope": "public", "docId": "kibSavedSearchPluginApi", "section": "def-public.SavedSearch", "text": "SavedSearch" }, " | undefined>; createAndAppendAdHocDataView: (dataViewSpec: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewSpec", "text": "DataViewSpec" }, ") => Promise<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, ">; onDataViewCreated: (dataView: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, ") => Promise; onDataViewEdited: (dataView: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, ") => Promise; onOpenSavedSearch: (savedSearchId: string) => void; onUpdateQuery: (payload: { dateRange: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "; query?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, " | undefined; }, isUpdate?: boolean | undefined) => void; onChangeDataView: (id: string) => Promise; setDataView: (dataView: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataView", "text": "DataView" }, ") => void; undoSavedSearchChanges: () => void; updateAdHocDataViewId: () => void; }" ], "path": "src/plugins/discover/public/application/main/services/discover_state.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.FlyoutCustomization", "type": "Interface", "tags": [], "label": "FlyoutCustomization", "description": [], "path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-public.FlyoutCustomization.id", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "\"flyout\"" ], "path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.FlyoutCustomization.actions", "type": "Object", "tags": [], "label": "actions", "description": [], "signature": [ "{ defaultActions?: ", "FlyoutDefaultActions", " | undefined; getActionItems?: (() => ", "FlyoutActionItem", "[]) | undefined; }" ], "path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts", "deprecated": false, "trackAdoption": 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", ", any>" ], "path": "src/plugins/discover/public/embeddable/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-public.ISearchEmbeddable.getSavedSearch", "type": "Function", "tags": [], "label": "getSavedSearch", "description": [], "signature": [ "() => ", { "pluginId": "savedSearch", "scope": "public", "docId": "kibSavedSearchPluginApi", "section": "def-public.SavedSearch", "text": "SavedSearch" } ], "path": "src/plugins/discover/public/embeddable/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "discover", "id": "def-public.ISearchEmbeddable.hasTimeRange", "type": "Function", "tags": [], "label": "hasTimeRange", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/discover/public/embeddable/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.SearchBarCustomization", "type": "Interface", "tags": [], "label": "SearchBarCustomization", "description": [], "path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-public.SearchBarCustomization.id", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "\"search_bar\"" ], "path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.SearchBarCustomization.CustomDataViewPicker", "type": "CompoundType", "tags": [], "label": "CustomDataViewPicker", "description": [], "signature": [ "React.ComponentType<{}> | undefined" ], "path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.SearchBarCustomization.PrependFilterBar", "type": "CompoundType", "tags": [], "label": "PrependFilterBar", "description": [], "signature": [ "React.ComponentType<{}> | undefined" ], "path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.SearchBarCustomization.CustomSearchBar", "type": "CompoundType", "tags": [], "label": "CustomSearchBar", "description": [], "signature": [ "React.ComponentType<", { "pluginId": "navigation", "scope": "public", "docId": "kibNavigationPluginApi", "section": "def-public.TopNavMenuProps", "text": "TopNavMenuProps" }, "<", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, ">> | undefined" ], "path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.TopNavCustomization", "type": "Interface", "tags": [], "label": "TopNavCustomization", "description": [], "path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-public.TopNavCustomization.id", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "\"top_nav\"" ], "path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.TopNavCustomization.defaultMenu", "type": "Object", "tags": [], "label": "defaultMenu", "description": [], "signature": [ "TopNavDefaultMenu", " | undefined" ], "path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.TopNavCustomization.getMenuItems", "type": "Function", "tags": [], "label": "getMenuItems", "description": [], "signature": [ "(() => ", "TopNavMenuItem", "[]) | undefined" ], "path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "discover", "id": "def-public.CustomizationCallback", "type": "Type", "tags": [], "label": "CustomizationCallback", "description": [], "signature": [ "(options: ", "CustomizationCallbackContext", ") => void | (() => void) | Promise void)>" ], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "discover", "id": "def-public.CustomizationCallback.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "CustomizationCallbackContext" ], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverContainerProps", "type": "Type", "tags": [], "label": "DiscoverContainerProps", "description": [], "signature": [ "{ isLoading?: boolean | undefined; overrideServices: Partial<", "DiscoverServices", ">; scopedHistory: ", { "pluginId": "@kbn/core-application-browser", "scope": "common", "docId": "kibKbnCoreApplicationBrowserPluginApi", "section": "def-common.ScopedHistory", "text": "ScopedHistory" }, "; customizationCallbacks: ", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.CustomizationCallback", "text": "CustomizationCallback" }, "[]; }" ], "path": "src/plugins/discover/public/components/discover_container/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverCustomization", "type": "Type", "tags": [], "label": "DiscoverCustomization", "description": [], "signature": [ { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.FlyoutCustomization", "text": "FlyoutCustomization" }, " | ", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.SearchBarCustomization", "text": "SearchBarCustomization" }, " | ", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.TopNavCustomization", "text": "TopNavCustomization" }, " | ", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.UnifiedHistogramCustomization", "text": "UnifiedHistogramCustomization" } ], "path": "src/plugins/discover/public/customizations/customization_service.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverProfileId", "type": "Type", "tags": [], "label": "DiscoverProfileId", "description": [], "signature": [ "string" ], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.RegisterCustomizationProfile", "type": "Type", "tags": [], "label": "RegisterCustomizationProfile", "description": [], "signature": [ "(id: string, options: ", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.DiscoverProfileOptions", "text": "DiscoverProfileOptions" }, ") => void" ], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "discover", "id": "def-public.RegisterCustomizationProfile.$1", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.RegisterCustomizationProfile.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.DiscoverProfileOptions", "text": "DiscoverProfileOptions" } ], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.SEARCH_EMBEDDABLE_CELL_ACTIONS_TRIGGER_ID", "type": "string", "tags": [], "label": "SEARCH_EMBEDDABLE_CELL_ACTIONS_TRIGGER_ID", "description": [], "signature": [ "\"SEARCH_EMBEDDABLE_CELL_ACTIONS_TRIGGER_ID\"" ], "path": "src/plugins/discover/public/embeddable/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.SEARCH_EMBEDDABLE_TYPE", "type": "string", "tags": [], "label": "SEARCH_EMBEDDABLE_TYPE", "description": [], "signature": [ "\"search\"" ], "path": "packages/kbn-discover-utils/src/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.SearchInput", "type": "Type", "tags": [], "label": "SearchInput", "description": [], "signature": [ { "pluginId": "savedSearch", "scope": "public", "docId": "kibSavedSearchPluginApi", "section": "def-public.SearchByValueInput", "text": "SearchByValueInput" }, " | ", { "pluginId": "savedSearch", "scope": "public", "docId": "kibSavedSearchPluginApi", "section": "def-public.SearchByReferenceInput", "text": "SearchByReferenceInput" } ], "path": "src/plugins/discover/public/embeddable/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-public.UnifiedHistogramCustomization", "type": "Type", "tags": [], "label": "UnifiedHistogramCustomization", "description": [], "signature": [ "UnifiedHistogramCustomizationId & Pick<", { "pluginId": "unifiedHistogram", "scope": "public", "docId": "kibUnifiedHistogramPluginApi", "section": "def-public.UnifiedHistogramContainerProps", "text": "UnifiedHistogramContainerProps" }, ", \"onBrushEnd\" | \"disabledActions\" | \"onFilter\" | \"withDefaultActions\">" ], "path": "src/plugins/discover/public/customizations/customization_types/histogram_customization.tsx", "deprecated": false, "trackAdoption": 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, "trackAdoption": false, "children": [ { "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": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocator", "text": "DiscoverAppLocator" }, " | undefined" ], "path": "src/plugins/discover/public/plugin.tsx", "deprecated": false, "trackAdoption": 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, "trackAdoption": false, "children": [ { "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": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocator", "text": "DiscoverAppLocator" }, " | undefined" ], "path": "src/plugins/discover/public/plugin.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverStart.DiscoverContainer", "type": "CompoundType", "tags": [], "label": "DiscoverContainer", "description": [], "signature": [ "React.ComponentClass<", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.DiscoverContainerProps", "text": "DiscoverContainerProps" }, ", any> | React.FunctionComponent<", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.DiscoverContainerProps", "text": "DiscoverContainerProps" }, ">" ], "path": "src/plugins/discover/public/plugin.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverStart.registerCustomizationProfile", "type": "Function", "tags": [], "label": "registerCustomizationProfile", "description": [], "signature": [ "(id: string, options: ", { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.DiscoverProfileOptions", "text": "DiscoverProfileOptions" }, ") => void" ], "path": "src/plugins/discover/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "discover", "id": "def-public.DiscoverStart.registerCustomizationProfile.$1", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-public.DiscoverStart.registerCustomizationProfile.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "discover", "scope": "public", "docId": "kibDiscoverPluginApi", "section": "def-public.DiscoverProfileOptions", "text": "DiscoverProfileOptions" } ], "path": "src/plugins/discover/public/customizations/types.ts", "deprecated": false, "trackAdoption": false } ] } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "discover", "id": "def-server.DiscoverServerPluginLocatorService", "type": "Interface", "tags": [], "label": "DiscoverServerPluginLocatorService", "description": [], "path": "src/plugins/discover/server/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-server.DiscoverServerPluginLocatorService.asScopedClient", "type": "Function", "tags": [], "label": "asScopedClient", "description": [], "signature": [ "(req: ", { "pluginId": "@kbn/core-http-server", "scope": "common", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-common.KibanaRequest", "text": "KibanaRequest" }, ") => Promise<", { "pluginId": "discover", "scope": "server", "docId": "kibDiscoverPluginApi", "section": "def-server.LocatorServiceScopedClient", "text": "LocatorServiceScopedClient" }, ">" ], "path": "src/plugins/discover/server/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-server.DiscoverServerPluginLocatorService.asScopedClient.$1", "type": "Object", "tags": [], "label": "req", "description": [], "signature": [ { "pluginId": "@kbn/core-http-server", "scope": "common", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-common.KibanaRequest", "text": "KibanaRequest" }, "" ], "path": "src/plugins/discover/server/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-server.DiscoverServerPluginStartDeps", "type": "Interface", "tags": [], "label": "DiscoverServerPluginStartDeps", "description": [], "path": "src/plugins/discover/server/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-server.DiscoverServerPluginStartDeps.data", "type": "Object", "tags": [], "label": "data", "description": [], "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataPluginApi", "section": "def-server.DataPluginStart", "text": "DataPluginStart" } ], "path": "src/plugins/discover/server/index.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-server.LocatorServiceScopedClient", "type": "Interface", "tags": [], "label": "LocatorServiceScopedClient", "description": [], "path": "src/plugins/discover/server/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-server.LocatorServiceScopedClient.columnsFromLocator", "type": "Function", "tags": [], "label": "columnsFromLocator", "description": [], "signature": [ "(params: ", { "pluginId": "discover", "scope": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" }, ") => Promise" ], "path": "src/plugins/discover/server/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "discover", "id": "def-server.LocatorServiceScopedClient.columnsFromLocator.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "discover", "scope": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" } ], "path": "src/plugins/discover/server/locator/columns_from_locator.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "discover", "id": "def-server.LocatorServiceScopedClient.searchSourceFromLocator", "type": "Function", "tags": [], "label": "searchSourceFromLocator", "description": [], "signature": [ "(params: ", { "pluginId": "discover", "scope": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" }, ") => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ">" ], "path": "src/plugins/discover/server/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "discover", "id": "def-server.LocatorServiceScopedClient.searchSourceFromLocator.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "discover", "scope": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" } ], "path": "src/plugins/discover/server/locator/searchsource_from_locator.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "discover", "id": "def-server.LocatorServiceScopedClient.titleFromLocator", "type": "Function", "tags": [], "label": "titleFromLocator", "description": [], "signature": [ "(params: ", { "pluginId": "discover", "scope": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" }, ") => Promise" ], "path": "src/plugins/discover/server/index.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "discover", "id": "def-server.LocatorServiceScopedClient.titleFromLocator.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "discover", "scope": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" } ], "path": "src/plugins/discover/server/locator/title_from_locator.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [], "start": { "parentPluginId": "discover", "id": "def-server.DiscoverServerPluginStart", "type": "Interface", "tags": [], "label": "DiscoverServerPluginStart", "description": [], "path": "src/plugins/discover/server/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-server.DiscoverServerPluginStart.locator", "type": "Object", "tags": [], "label": "locator", "description": [], "signature": [ { "pluginId": "discover", "scope": "server", "docId": "kibDiscoverPluginApi", "section": "def-server.DiscoverServerPluginLocatorService", "text": "DiscoverServerPluginLocatorService" } ], "path": "src/plugins/discover/server/index.ts", "deprecated": false, "trackAdoption": false } ], "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [ { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorDefinition", "type": "Class", "tags": [], "label": "DiscoverAppLocatorDefinition", "description": [], "signature": [ { "pluginId": "discover", "scope": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocatorDefinition", "text": "DiscoverAppLocatorDefinition" }, " implements ", { "pluginId": "share", "scope": "common", "docId": "kibSharePluginApi", "section": "def-common.LocatorDefinition", "text": "LocatorDefinition" }, "<", { "pluginId": "discover", "scope": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" }, ">" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorDefinition.id", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "\"DISCOVER_APP_LOCATOR\"" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorDefinition.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorDefinition.Unnamed.$1", "type": "Object", "tags": [], "label": "deps", "description": [], "signature": [ "DiscoverAppLocatorDependencies" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorDefinition.getLocation", "type": "Function", "tags": [], "label": "getLocation", "description": [], "signature": [ "(params: ", { "pluginId": "discover", "scope": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" }, ") => Promise<{ app: string; path: string; state: ", "MainHistoryLocationState", "; }>" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorDefinition.getLocation.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "discover", "scope": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" } ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [], "interfaces": [ { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams", "type": "Interface", "tags": [], "label": "DiscoverAppLocatorParams", "description": [], "signature": [ { "pluginId": "discover", "scope": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" }, " extends ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" } ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.savedSearchId", "type": "string", "tags": [], "label": "savedSearchId", "description": [ "\nOptionally set saved search ID." ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.dataViewId", "type": "string", "tags": [], "label": "dataViewId", "description": [ "\nOptionally set index pattern / data view ID." ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.indexPatternId", "type": "string", "tags": [ "deprecated" ], "label": "indexPatternId", "description": [ "\nDuplication of dataViewId" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "exploratoryView", "path": "x-pack/plugins/exploratory_view/public/components/shared/exploratory_view/hooks/use_discover_link.tsx" }, { "plugin": "fleet", "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/multi_page_layout/hooks/use_get_logs_discover_link.tsx" }, { "plugin": "dataVisualizer", "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" }, { "plugin": "dataVisualizer", "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx" }, { "plugin": "cloudSecurityPosture", "path": "x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/overview_tab.tsx" }, { "plugin": "discoverEnhanced", "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" }, { "plugin": "discoverEnhanced", "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts" }, { "plugin": "osquery", "path": "x-pack/plugins/osquery/public/packs/pack_queries_status_table.tsx" }, { "plugin": "osquery", "path": "x-pack/plugins/osquery/public/discover/view_results_in_discover.tsx" }, { "plugin": "osquery", "path": "x-pack/plugins/osquery/public/common/hooks/use_discover_link.tsx" }, { "plugin": "synthetics", "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/common/components/stderr_logs.tsx" } ] }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.dataViewSpec", "type": "Object", "tags": [], "label": "dataViewSpec", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewSpec", "text": "DataViewSpec" }, " | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.timeRange", "type": "Object", "tags": [], "label": "timeRange", "description": [ "\nOptionally set the time range in the time picker." ], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.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": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, ") | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.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/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.query", "type": "CompoundType", "tags": [], "label": "query", "description": [ "\nOptionally set a query." ], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.AggregateQuery", "text": "AggregateQuery" }, " | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.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/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.searchSessionId", "type": "string", "tags": [], "label": "searchSessionId", "description": [ "\nBackground search session id" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.columns", "type": "Array", "tags": [], "label": "columns", "description": [ "\nColumns displayed in the table" ], "signature": [ "string[] | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.interval", "type": "string", "tags": [], "label": "interval", "description": [ "\nUsed interval of the histogram" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.sort", "type": "Array", "tags": [], "label": "sort", "description": [ "\nArray of the used sorting [[field,direction],...]" ], "signature": [ "string[][] | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.savedQuery", "type": "string", "tags": [], "label": "savedQuery", "description": [ "\nid of the used saved query" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.viewMode", "type": "CompoundType", "tags": [], "label": "viewMode", "description": [ "\nTable view: Documents vs Field Statistics" ], "signature": [ "VIEW_MODE", " | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.hideAggregatedPreview", "type": "CompoundType", "tags": [], "label": "hideAggregatedPreview", "description": [ "\nHide mini distribution/preview charts when in Field Statistics mode" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.breakdownField", "type": "string", "tags": [], "label": "breakdownField", "description": [ "\nBreakdown field" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.isAlertResults", "type": "CompoundType", "tags": [], "label": "isAlertResults", "description": [ "\nUsed when navigating to particular alert results" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocatorParams.profile", "type": "string", "tags": [], "label": "profile", "description": [ "\nThe Discover profile to use" ], "signature": [ "string | undefined" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "discover", "id": "def-common.APP_ICON", "type": "string", "tags": [], "label": "APP_ICON", "description": [], "signature": [ "\"discoverApp\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.DISCOVER_APP_LOCATOR", "type": "string", "tags": [], "label": "DISCOVER_APP_LOCATOR", "description": [], "signature": [ "\"DISCOVER_APP_LOCATOR\"" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.DiscoverAppLocator", "type": "Type", "tags": [], "label": "DiscoverAppLocator", "description": [], "signature": [ { "pluginId": "share", "scope": "common", "docId": "kibSharePluginApi", "section": "def-common.LocatorPublic", "text": "LocatorPublic" }, "<", { "pluginId": "discover", "scope": "common", "docId": "kibDiscoverPluginApi", "section": "def-common.DiscoverAppLocatorParams", "text": "DiscoverAppLocatorParams" }, ">" ], "path": "src/plugins/discover/common/locator.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "discover", "id": "def-common.PLUGIN_ID", "type": "string", "tags": [], "label": "PLUGIN_ID", "description": [], "signature": [ "\"discover\"" ], "path": "src/plugins/discover/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }