mirror of
https://github.com/elastic/kibana.git
synced 2025-04-19 15:35:00 -04:00
4981 lines
No EOL
178 KiB
JSON
4981 lines
No EOL
178 KiB
JSON
{
|
|
"id": "discover",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.apiPublishesSavedSearch",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "apiPublishesSavedSearch",
|
|
"description": [],
|
|
"signature": [
|
|
"(api: unknown) => api is ",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-public.PublishesSavedSearch",
|
|
"text": "PublishesSavedSearch"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.apiPublishesSavedSearch.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "api",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.loadSharingDataHelpers",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "loadSharingDataHelpers",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<typeof ",
|
|
"src/platform/plugins/shared/discover/public/utils/get_sharing_data",
|
|
">"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DataDocumentsMsg",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DataDocumentsMsg",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-public.DataDocumentsMsg",
|
|
"text": "DataDocumentsMsg"
|
|
},
|
|
" extends ",
|
|
"DataMsg"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/discover_data_state_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DataDocumentsMsg.result",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "result",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/discover-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnDiscoverUtilsPluginApi",
|
|
"section": "def-common.DataTableRecord",
|
|
"text": "DataTableRecord"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/discover_data_state_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DataDocumentsMsg.esqlQueryColumns",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "esqlQueryColumns",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/discover_data_state_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DataDocumentsMsg.esqlHeaderWarning",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esqlHeaderWarning",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/discover_data_state_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DataDocumentsMsg.interceptedWarnings",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "interceptedWarnings",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchResponseIncompleteWarning",
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/discover_data_state_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverAppState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DiscoverAppState",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.DiscoverGridSettings",
|
|
"text": "DiscoverGridSettings"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/discover_app_state_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverAppState.dataSource",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "dataSource",
|
|
"description": [
|
|
"\nThe current data source"
|
|
],
|
|
"signature": [
|
|
"DiscoverDataSource",
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/discover_app_state_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverAppState.headerRowHeight",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "headerRowHeight",
|
|
"description": [
|
|
"\nDocument explorer header row height option"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/discover_app_state_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverAppState.sampleSize",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "sampleSize",
|
|
"description": [
|
|
"\nCustom sample size"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/discover_app_state_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverAppState.density",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "density",
|
|
"description": [
|
|
"\nDensity of table"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/unified-data-table",
|
|
"scope": "public",
|
|
"docId": "kibKbnUnifiedDataTablePluginApi",
|
|
"section": "def-public.DataGridDensity",
|
|
"text": "DataGridDensity"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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": [
|
|
"<TCustomizationId extends \"flyout\" | \"search_bar\" | \"top_nav\" | \"unified_histogram\" | \"data_table\" | \"field_list\">(id: TCustomizationId) => Extract<",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-public.FlyoutCustomization",
|
|
"text": "FlyoutCustomization"
|
|
},
|
|
", { id: TCustomizationId; }> | 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; }> | Extract<",
|
|
"DataTableCustomization",
|
|
", { id: TCustomizationId; }> | Extract<",
|
|
"FieldListCustomization",
|
|
", { id: TCustomizationId; }> | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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": [
|
|
"<TCustomizationId extends \"flyout\" | \"search_bar\" | \"top_nav\" | \"unified_histogram\" | \"data_table\" | \"field_list\">(id: TCustomizationId) => ",
|
|
"Observable",
|
|
"<Extract<",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-public.FlyoutCustomization",
|
|
"text": "FlyoutCustomization"
|
|
},
|
|
", { id: TCustomizationId; }> | 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; }> | Extract<",
|
|
"DataTableCustomization",
|
|
", { id: TCustomizationId; }> | Extract<",
|
|
"FieldListCustomization",
|
|
", { id: TCustomizationId; }> | undefined>"
|
|
],
|
|
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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\" | \"data_table\" | \"field_list\") => void"
|
|
],
|
|
"path": "src/platform/plugins/shared/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\" | \"data_table\" | \"field_list\""
|
|
],
|
|
"path": "src/platform/plugins/shared/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\" | \"data_table\" | \"field_list\") => void"
|
|
],
|
|
"path": "src/platform/plugins/shared/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\" | \"data_table\" | \"field_list\""
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/customizations/customization_service.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DiscoverServices",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.aiops",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "aiops",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "aiops",
|
|
"scope": "public",
|
|
"docId": "kibAiopsPluginApi",
|
|
"section": "def-public.AiopsPluginStart",
|
|
"text": "AiopsPluginStart"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.application",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "application",
|
|
"description": [],
|
|
"signature": [
|
|
"ApplicationStart"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.addBasePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addBasePath",
|
|
"description": [],
|
|
"signature": [
|
|
"(path: string) => string"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.addBasePath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.analytics",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "analytics",
|
|
"description": [],
|
|
"signature": [
|
|
"{ optIn: (optInConfig: ",
|
|
"OptInConfig",
|
|
") => void; reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.i18n",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "i18n",
|
|
"description": [],
|
|
"signature": [
|
|
"I18nStart"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.capabilities",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "capabilities",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [key: string]: Record<string, boolean | Record<string, boolean>>; navLinks: Record<string, boolean>; management: { [sectionId: string]: Record<string, boolean>; }; catalogue: Record<string, boolean>; } & { discover?: {} | undefined; dashboard?: {} | undefined; maps?: {} | undefined; visualize?: {} | undefined; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.chrome",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "chrome",
|
|
"description": [],
|
|
"signature": [
|
|
"ChromeStart"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.core",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
"CoreStart"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-public.DataPublicPluginStart",
|
|
"text": "DataPublicPluginStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.discoverShared",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "discoverShared",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "discoverShared",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverSharedPluginApi",
|
|
"section": "def-public.DiscoverSharedPublicStart",
|
|
"text": "DiscoverSharedPublicStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.docLinks",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "docLinks",
|
|
"description": [],
|
|
"signature": [
|
|
"DocLinksStart"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.embeddable",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "embeddable",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableStart",
|
|
"text": "EmbeddableStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.history",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "history",
|
|
"description": [],
|
|
"signature": [
|
|
"History",
|
|
"<",
|
|
"HistoryLocationState",
|
|
">"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.getScopedHistory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getScopedHistory",
|
|
"description": [],
|
|
"signature": [
|
|
"<T>() => ",
|
|
"ScopedHistory",
|
|
"<T | undefined> | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.setHeaderActionMenu",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setHeaderActionMenu",
|
|
"description": [],
|
|
"signature": [
|
|
"(menuMount: ",
|
|
"MountPoint",
|
|
"<HTMLElement> | undefined) => void"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.setHeaderActionMenu.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "menuMount",
|
|
"description": [],
|
|
"signature": [
|
|
"MountPoint",
|
|
"<HTMLElement> | undefined"
|
|
],
|
|
"path": "src/core/packages/application/browser/src/app_mount.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.theme",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "theme",
|
|
"description": [],
|
|
"signature": [
|
|
"ThemeServiceSetup"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.userProfile",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "userProfile",
|
|
"description": [],
|
|
"signature": [
|
|
"UserProfileService"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.filterManager",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "filterManager",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-public.FilterManager",
|
|
"text": "FilterManager"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.fieldFormats",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "fieldFormats",
|
|
"description": [],
|
|
"signature": [
|
|
"Omit<",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsRegistry",
|
|
"text": "FieldFormatsRegistry"
|
|
},
|
|
", \"init\" | \"register\"> & { deserialize: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FormatFactory",
|
|
"text": "FormatFactory"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.dataViews",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataViews",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "public",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-public.DataViewsServicePublic",
|
|
"text": "DataViewsServicePublic"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.inspector",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "inspector",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "public",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-public.Start",
|
|
"text": "Start"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.metadata",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "metadata",
|
|
"description": [],
|
|
"signature": [
|
|
"{ branch: string; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.navigation",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "navigation",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "navigation",
|
|
"scope": "public",
|
|
"docId": "kibNavigationPluginApi",
|
|
"section": "def-public.NavigationPublicStart",
|
|
"text": "NavigationPublicStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.share",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "share",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.SharePublicStart",
|
|
"text": "SharePublicStart"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.urlForwarding",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "urlForwarding",
|
|
"description": [],
|
|
"signature": [
|
|
"{ navigateToLegacyKibanaUrl: (hash: string) => { navigated: boolean; }; getForwards: () => ",
|
|
{
|
|
"pluginId": "urlForwarding",
|
|
"scope": "public",
|
|
"docId": "kibUrlForwardingPluginApi",
|
|
"section": "def-public.ForwardDefinition",
|
|
"text": "ForwardDefinition"
|
|
},
|
|
"[]; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.urlTracker",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "urlTracker",
|
|
"description": [],
|
|
"signature": [
|
|
"UrlTracker"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.timefilter",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timefilter",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly useTimefilter: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-public.TimefilterHook",
|
|
"text": "TimefilterHook"
|
|
},
|
|
"; isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; isRefreshIntervalTouched: () => boolean; getEnabledUpdated$: () => ",
|
|
"Observable",
|
|
"<boolean>; getTimeUpdate$: () => ",
|
|
"Observable",
|
|
"<void>; getRefreshIntervalUpdate$: () => ",
|
|
"Observable",
|
|
"<void>; getAutoRefreshFetch$: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-public.AutoRefreshDoneFn",
|
|
"text": "AutoRefreshDoneFn"
|
|
},
|
|
">; getFetch$: () => ",
|
|
"Observable",
|
|
"<void>; getTime: () => ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
"; getAbsoluteTime: () => ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
"; setTime: (time: ",
|
|
"InputTimeRange",
|
|
") => void; getRefreshInterval: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.RefreshInterval",
|
|
"text": "RefreshInterval"
|
|
},
|
|
"; getMinRefreshInterval: () => number; setRefreshInterval: (refreshInterval: Partial<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.RefreshInterval",
|
|
"text": "RefreshInterval"
|
|
},
|
|
">) => void; createFilter: (indexPattern: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
", timeRange?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.RangeFilter",
|
|
"text": "RangeFilter"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.ScriptedRangeFilter",
|
|
"text": "ScriptedRangeFilter"
|
|
},
|
|
" | ",
|
|
"MatchAllRangeFilter",
|
|
" | undefined; createRelativeFilter: (indexPattern: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
", timeRange?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.RangeFilter",
|
|
"text": "RangeFilter"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.ScriptedRangeFilter",
|
|
"text": "ScriptedRangeFilter"
|
|
},
|
|
" | ",
|
|
"MatchAllRangeFilter",
|
|
" | undefined; getBounds: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRangeBounds",
|
|
"text": "TimeRangeBounds"
|
|
},
|
|
"; calculateBounds: (timeRange: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRangeBounds",
|
|
"text": "TimeRangeBounds"
|
|
},
|
|
"; getActiveBounds: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRangeBounds",
|
|
"text": "TimeRangeBounds"
|
|
},
|
|
" | undefined; enableTimeRangeSelector: () => void; disableTimeRangeSelector: () => void; enableAutoRefreshSelector: () => void; disableAutoRefreshSelector: () => void; getTimeDefaults: () => ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
"; getRefreshIntervalDefaults: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.RefreshInterval",
|
|
"text": "RefreshInterval"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.toastNotifications",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toastNotifications",
|
|
"description": [],
|
|
"signature": [
|
|
"IToasts"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.notifications",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "notifications",
|
|
"description": [],
|
|
"signature": [
|
|
"NotificationsStart"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.uiSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [],
|
|
"signature": [
|
|
"IUiSettingsClient"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.settings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "settings",
|
|
"description": [],
|
|
"signature": [
|
|
"SettingsStart"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.trackUiMetric",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "trackUiMetric",
|
|
"description": [],
|
|
"signature": [
|
|
"((metricType: string, eventName: string | string[]) => void) | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.trackUiMetric.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "metricType",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.trackUiMetric.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "eventName",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.dataViewFieldEditor",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataViewFieldEditor",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViewFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibDataViewFieldEditorPluginApi",
|
|
"section": "def-public.PluginStart",
|
|
"text": "PluginStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.dataViewEditor",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataViewEditor",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViewEditor",
|
|
"scope": "public",
|
|
"docId": "kibDataViewEditorPluginApi",
|
|
"section": "def-public.PluginStart",
|
|
"text": "PluginStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.dataVisualizer",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataVisualizer",
|
|
"description": [],
|
|
"signature": [
|
|
"{ getFileDataVisualizerComponent: () => Promise<() => ",
|
|
"SpecWithLinks",
|
|
"<React.FC<",
|
|
"Props",
|
|
">>>; getIndexDataVisualizerComponent: () => Promise<() => React.FC<",
|
|
"Props",
|
|
">>; getDataDriftComponent: () => Promise<() => React.FC<",
|
|
"DataDriftDetectionAppStateProps",
|
|
">>; getMaxBytesFormatted: () => string; FieldStatsUnavailableMessage: React.ForwardRefExoticComponent<{ id?: string | undefined; title?: string | undefined; } & React.RefAttributes<{}>>; FieldStatisticsTable: React.ForwardRefExoticComponent<",
|
|
"FieldStatisticTableEmbeddableProps",
|
|
" & React.RefAttributes<{}>>; } | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.http",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpSetup"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.storage",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "storage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "public",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-public.Storage",
|
|
"text": "Storage"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.spaces",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "spaces",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.SpacesApi",
|
|
"text": "SpacesApi"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.triggersActionsUi",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "triggersActionsUi",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "triggersActionsUi",
|
|
"scope": "public",
|
|
"docId": "kibTriggersActionsUiPluginApi",
|
|
"section": "def-public.TriggersAndActionsUIPublicPluginStart",
|
|
"text": "TriggersAndActionsUIPublicPluginStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.locator",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "locator",
|
|
"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/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.contextLocator",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "contextLocator",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "common",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-common.LocatorPublic",
|
|
"text": "LocatorPublic"
|
|
},
|
|
"<",
|
|
"DiscoverContextAppLocatorParams",
|
|
">"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.singleDocLocator",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "singleDocLocator",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "common",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-common.LocatorPublic",
|
|
"text": "LocatorPublic"
|
|
},
|
|
"<",
|
|
"DiscoverSingleDocLocatorParams",
|
|
">"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.expressions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "expressions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "public",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-public.ExpressionsStart",
|
|
"text": "ExpressionsStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.charts",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "charts",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "charts",
|
|
"scope": "public",
|
|
"docId": "kibChartsPluginApi",
|
|
"section": "def-public.ChartsPluginSetup",
|
|
"text": "ChartsPluginSetup"
|
|
},
|
|
" & { activeCursor: ",
|
|
"ActiveCursor",
|
|
"; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.savedObjectsManagement",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsManagement",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjectsManagement",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsManagementPluginApi",
|
|
"section": "def-public.SavedObjectsManagementPluginStart",
|
|
"text": "SavedObjectsManagementPluginStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.savedObjectsTagging",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsTagging",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjectsTaggingOss",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsTaggingOssPluginApi",
|
|
"section": "def-public.SavedObjectsTaggingApi",
|
|
"text": "SavedObjectsTaggingApi"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.savedSearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedSearch",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "public",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-public.SavedSearchPublicPluginStart",
|
|
"text": "SavedSearchPublicPluginStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.unifiedSearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "unifiedSearch",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "unifiedSearch",
|
|
"scope": "public",
|
|
"docId": "kibUnifiedSearchPluginApi",
|
|
"section": "def-public.UnifiedSearchPublicPluginStart",
|
|
"text": "UnifiedSearchPublicPluginStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.lens",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "lens",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "lens",
|
|
"scope": "public",
|
|
"docId": "kibLensPluginApi",
|
|
"section": "def-public.LensPublicStart",
|
|
"text": "LensPublicStart"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.uiActions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiActions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly registerTrigger: (trigger: ",
|
|
{
|
|
"pluginId": "@kbn/ui-actions-browser",
|
|
"scope": "common",
|
|
"docId": "kibKbnUiActionsBrowserPluginApi",
|
|
"section": "def-common.Trigger",
|
|
"text": "Trigger"
|
|
},
|
|
") => void; readonly hasTrigger: (triggerId: string) => boolean; readonly getTrigger: (triggerId: string) => ",
|
|
"TriggerContract",
|
|
"<object>; readonly registerAction: <Context extends object>(definition: ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<Context>) => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<Context>; readonly registerActionAsync: <Context extends object>(id: string, getDefinition: () => Promise<",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<Context>>) => void; readonly unregisterAction: (actionId: string) => void; readonly hasAction: (actionId: string) => boolean; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly addTriggerAction: (triggerId: string, action: ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<any>) => void; readonly addTriggerActionAsync: (triggerId: string, actionId: string, getDefinition: () => Promise<",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<any>>) => void; readonly getAction: (id: string) => Promise<",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<object>>; readonly getTriggerActions: (triggerId: string) => Promise<",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<object>[]>; readonly getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<object>[]>; readonly getFrequentlyChangingActionsForTrigger: (triggerId: string, context: object) => Promise<",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.FrequentCompatibilityChangeAction",
|
|
"text": "FrequentCompatibilityChangeAction"
|
|
},
|
|
"<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly clear: () => void; readonly fork: () => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.UiActionsService",
|
|
"text": "UiActionsService"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.contentClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "contentClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "contentManagement",
|
|
"scope": "public",
|
|
"docId": "kibContentManagementPluginApi",
|
|
"section": "def-public.ContentClient",
|
|
"text": "ContentClient"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.noDataPage",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "noDataPage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "noDataPage",
|
|
"scope": "public",
|
|
"docId": "kibNoDataPagePluginApi",
|
|
"section": "def-public.NoDataPagePublicSetup",
|
|
"text": "NoDataPagePublicSetup"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.observabilityAIAssistant",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "observabilityAIAssistant",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "observabilityAIAssistant",
|
|
"scope": "public",
|
|
"docId": "kibObservabilityAIAssistantPluginApi",
|
|
"section": "def-public.ObservabilityAIAssistantPublicStart",
|
|
"text": "ObservabilityAIAssistantPublicStart"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.profilesManager",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "profilesManager",
|
|
"description": [],
|
|
"signature": [
|
|
"ProfilesManager"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.ebtManager",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ebtManager",
|
|
"description": [],
|
|
"signature": [
|
|
"DiscoverEBTManager"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.fieldsMetadata",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fieldsMetadata",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldsMetadata",
|
|
"scope": "public",
|
|
"docId": "kibFieldsMetadataPluginApi",
|
|
"section": "def-public.FieldsMetadataPublicStart",
|
|
"text": "FieldsMetadataPublicStart"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.logsDataAccess",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logsDataAccess",
|
|
"description": [],
|
|
"signature": [
|
|
"{ services: { logSourcesService: ",
|
|
"LogSourcesService",
|
|
"; }; } | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.embeddableEnhanced",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "embeddableEnhanced",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddableEnhanced",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddableEnhancedPluginApi",
|
|
"section": "def-public.StartContract",
|
|
"text": "StartContract"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverServices.apmSourcesAccess",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "apmSourcesAccess",
|
|
"description": [],
|
|
"signature": [
|
|
"{ getApmIndices: (options?: Omit<",
|
|
{
|
|
"pluginId": "apmSourcesAccess",
|
|
"scope": "public",
|
|
"docId": "kibApmSourcesAccessPluginApi",
|
|
"section": "def-public.SourcesApiOptions",
|
|
"text": "SourcesApiOptions"
|
|
},
|
|
", \"body\"> | undefined) => Promise<Readonly<{} & { error: string; transaction: string; span: string; metric: string; onboarding: string; sourcemap: string; }>>; getApmIndexSettings: (options?: Omit<",
|
|
{
|
|
"pluginId": "apmSourcesAccess",
|
|
"scope": "public",
|
|
"docId": "kibApmSourcesAccessPluginApi",
|
|
"section": "def-public.SourcesApiOptions",
|
|
"text": "SourcesApiOptions"
|
|
},
|
|
", \"body\"> | undefined) => Promise<",
|
|
"ApmIndexSettingsResponse",
|
|
">; saveApmIndices: (options: ",
|
|
{
|
|
"pluginId": "apmSourcesAccess",
|
|
"scope": "public",
|
|
"docId": "kibApmSourcesAccessPluginApi",
|
|
"section": "def-public.SourcesApiOptions",
|
|
"text": "SourcesApiOptions"
|
|
},
|
|
" & { body: Partial<Record<\"error\" | \"transaction\" | \"span\" | \"metric\" | \"onboarding\" | \"sourcemap\", string>>; }) => Promise<",
|
|
"SavedObject",
|
|
"<{}>>; } | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/build_services.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverStateContainer",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DiscoverStateContainer",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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": [
|
|
"ToolkitStore",
|
|
"<",
|
|
"DiscoverInternalState",
|
|
", ",
|
|
"AnyAction",
|
|
", ",
|
|
"MiddlewareArray",
|
|
"<[",
|
|
"ThunkMiddleware",
|
|
"<",
|
|
"DiscoverInternalState",
|
|
", ",
|
|
"AnyAction",
|
|
", ",
|
|
"InternalStateThunkDependencies",
|
|
">]>>"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/discover_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverStateContainer.injectCurrentTab",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "injectCurrentTab",
|
|
"description": [
|
|
"\nInjects the current tab into a given internalState action"
|
|
],
|
|
"signature": [
|
|
"<TPayload extends { tabId: string; }, TReturn>(actionCreator: (params: TPayload) => TReturn) => (payload: VoidIfEmpty<WithoutTabId<TPayload>>) => TReturn"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/discover_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverStateContainer.injectCurrentTab.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "actionCreator",
|
|
"description": [],
|
|
"signature": [
|
|
"(params: TPayload) => TReturn"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/redux/utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverStateContainer.injectCurrentTab.$1.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"TPayload"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/redux/utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverStateContainer.getCurrentTab",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getCurrentTab",
|
|
"description": [
|
|
"\nGets the state of the current tab"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"TabState"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/discover_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverStateContainer.runtimeStateManager",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "runtimeStateManager",
|
|
"description": [
|
|
"\nState manager for runtime state that can't be stored in Redux"
|
|
],
|
|
"signature": [
|
|
"ReactiveRuntimeState<DiscoverRuntimeState, never> & { tabs: { byId: Record<string, ReactiveTabRuntimeState>; }; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/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/platform/plugins/shared/discover/public/application/main/state_management/discover_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverStateContainer.customizationContext",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "customizationContext",
|
|
"description": [
|
|
"\nContext object for customization related properties"
|
|
],
|
|
"signature": [
|
|
"DiscoverCustomizationContext"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/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; stopSyncing: () => void; 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<void>; onDataViewEdited: (dataView: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
") => Promise<void>; transitionFromESQLToDataView: (dataViewId: string) => void; transitionFromDataViewToESQL: (dataView: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
") => void; 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 | ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
") => Promise<void>; setDataView: (dataView: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
") => void; undoSavedSearchChanges: () => Promise<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "public",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-public.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
">; updateAdHocDataViewId: () => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
" | undefined>; updateESQLQuery: (queryOrUpdater: string | ((prevQuery: string) => string)) => void; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/application/main/state_management/discover_state.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.FlyoutCustomization",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FlyoutCustomization",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/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/platform/plugins/shared/discover/public/customizations/customization_types/flyout_customization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.FlyoutCustomization.size",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "size",
|
|
"description": [],
|
|
"signature": [
|
|
"Property",
|
|
".Width<string | number> | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/customizations/customization_types/flyout_customization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.FlyoutCustomization.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/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/platform/plugins/shared/discover/public/customizations/customization_types/flyout_customization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.FlyoutCustomization.Content",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "Content",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ComponentType<",
|
|
"FlyoutContentProps",
|
|
"> | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/customizations/customization_types/flyout_customization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.FlyoutCustomization.docViewsRegistry",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "docViewsRegistry",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/unified-doc-viewer",
|
|
"scope": "common",
|
|
"docId": "kibKbnUnifiedDocViewerPluginApi",
|
|
"section": "def-common.DocViewsRegistry",
|
|
"text": "DocViewsRegistry"
|
|
},
|
|
" | ((prevRegistry: ",
|
|
{
|
|
"pluginId": "@kbn/unified-doc-viewer",
|
|
"scope": "common",
|
|
"docId": "kibKbnUnifiedDocViewerPluginApi",
|
|
"section": "def-common.DocViewsRegistry",
|
|
"text": "DocViewsRegistry"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/unified-doc-viewer",
|
|
"scope": "common",
|
|
"docId": "kibKbnUnifiedDocViewerPluginApi",
|
|
"section": "def-common.DocViewsRegistry",
|
|
"text": "DocViewsRegistry"
|
|
},
|
|
") | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/customizations/customization_types/flyout_customization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.HasTimeRange",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HasTimeRange",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.HasTimeRange.hasTimeRange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "hasTimeRange",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.NonPersistedDisplayOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NonPersistedDisplayOptions",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.NonPersistedDisplayOptions.solutionNavIdOverride",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "solutionNavIdOverride",
|
|
"description": [],
|
|
"signature": [
|
|
"\"search\" | \"security\" | \"oblt\" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.NonPersistedDisplayOptions.enableDocumentViewer",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "enableDocumentViewer",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.NonPersistedDisplayOptions.enableFilters",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "enableFilters",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.PublishesSavedSearch",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PublishesSavedSearch",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.PublishesSavedSearch.savedSearch$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedSearch$",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: ",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
"; error: (err: any) => void; forEach: { (next: (value: ",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
") => void): Promise<void>; (next: (value: ",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
") => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => ",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
"; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
">; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
", A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; operator: ",
|
|
"Operator",
|
|
"<any, ",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
"> | undefined; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
", R>) => ",
|
|
"Observable",
|
|
"<R>; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
">> | ((value: ",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
") => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: ",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
") => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
" | undefined>; (PromiseCtor: PromiseConstructor): Promise<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
" | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
" | undefined>; }; observers: ",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
">[]; isStopped: boolean; hasError: boolean; thrownError: any; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.SavedSearch",
|
|
"text": "SavedSearch"
|
|
},
|
|
">; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.SearchBarCustomization",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SearchBarCustomization",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/discover/public/customizations/customization_types/search_bar_customization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.SearchBarCustomization.hideDataViewPicker",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hideDataViewPicker",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/discover/public/customizations/customization_types/top_nav_customization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.TopNavCustomization.defaultBadges",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "defaultBadges",
|
|
"description": [],
|
|
"signature": [
|
|
"TopNavDefaultBadges",
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/customizations/customization_types/top_nav_customization.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.CustomizationCallback",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CustomizationCallback",
|
|
"description": [],
|
|
"signature": [
|
|
"(options: ",
|
|
"CustomizationCallbackContext",
|
|
") => void | (() => void) | Promise<void | (() => void)>"
|
|
],
|
|
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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<",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-public.DiscoverServices",
|
|
"text": "DiscoverServices"
|
|
},
|
|
">; scopedHistory: ",
|
|
"ScopedHistory",
|
|
"<unknown>; customizationCallbacks: ",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-public.CustomizationCallback",
|
|
"text": "CustomizationCallback"
|
|
},
|
|
"[]; stateStorageContainer?: ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "public",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-public.IKbnUrlStateStorage",
|
|
"text": "IKbnUrlStateStorage"
|
|
},
|
|
" | undefined; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/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"
|
|
},
|
|
" | ",
|
|
"DataTableCustomization",
|
|
" | ",
|
|
"FieldListCustomization"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/customizations/customization_service.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/platform/plugins/shared/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": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.SearchEmbeddableApi",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SearchEmbeddableApi",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.DefaultEmbeddableApi",
|
|
"text": "DefaultEmbeddableApi"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-public.SearchEmbeddableSerializedState",
|
|
"text": "SearchEmbeddableSerializedState"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-public.SearchEmbeddableRuntimeState",
|
|
"text": "SearchEmbeddableRuntimeState"
|
|
},
|
|
"> & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesSavedObjectId",
|
|
"text": "PublishesSavedObjectId"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesDataLoading",
|
|
"text": "PublishesDataLoading"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesBlockingError",
|
|
"text": "PublishesBlockingError"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesTitle",
|
|
"text": "PublishesTitle"
|
|
},
|
|
" & { setTitle: (newTitle: string | undefined) => void; setHideTitle: (hide: boolean | undefined) => void; } & ",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-public.PublishesSavedSearch",
|
|
"text": "PublishesSavedSearch"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesDataViews",
|
|
"text": "PublishesDataViews"
|
|
},
|
|
" & { setDataViews: (dataViews: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[]) => void; } & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesTimeRange",
|
|
"text": "PublishesTimeRange"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesFilters",
|
|
"text": "PublishesFilters"
|
|
},
|
|
" & { isCompatibleWithUnifiedSearch?: (() => boolean) | undefined; canEditUnifiedSearch?: (() => boolean) | undefined; query$: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishingSubject",
|
|
"text": "PublishingSubject"
|
|
},
|
|
"<",
|
|
{
|
|
"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>; } & { setTimeRange: (timeRange: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined) => void; } & { setFilters: (filters: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined) => void; setQuery: (query: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | undefined) => void; } & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.HasLibraryTransforms",
|
|
"text": "HasLibraryTransforms"
|
|
},
|
|
"<object, object> & ",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-public.HasTimeRange",
|
|
"text": "HasTimeRange"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "public",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-public.HasInspectorAdapters",
|
|
"text": "HasInspectorAdapters"
|
|
},
|
|
" & Partial<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.HasEditCapabilities",
|
|
"text": "HasEditCapabilities"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesSavedObjectId",
|
|
"text": "PublishesSavedObjectId"
|
|
},
|
|
"> & Partial<{ enhancements: { dynamicActions: ",
|
|
{
|
|
"pluginId": "uiActionsEnhanced",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsEnhancedPluginApi",
|
|
"section": "def-public.DynamicActionManager",
|
|
"text": "DynamicActionManager"
|
|
},
|
|
"; }; setDynamicActions: (newState: { dynamicActions: ",
|
|
{
|
|
"pluginId": "uiActionsEnhanced",
|
|
"scope": "common",
|
|
"docId": "kibUiActionsEnhancedPluginApi",
|
|
"section": "def-common.DynamicActionsState",
|
|
"text": "DynamicActionsState"
|
|
},
|
|
"; } | undefined) => void; dynamicActionsState$: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishingSubject",
|
|
"text": "PublishingSubject"
|
|
},
|
|
"<{ dynamicActions: ",
|
|
{
|
|
"pluginId": "uiActionsEnhanced",
|
|
"scope": "common",
|
|
"docId": "kibUiActionsEnhancedPluginApi",
|
|
"section": "def-common.DynamicActionsState",
|
|
"text": "DynamicActionsState"
|
|
},
|
|
"; } | undefined>; }> & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.HasSupportedTriggers",
|
|
"text": "HasSupportedTriggers"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.SearchEmbeddableRuntimeState",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SearchEmbeddableRuntimeState",
|
|
"description": [],
|
|
"signature": [
|
|
"Omit<",
|
|
"SearchEmbeddableState",
|
|
", \"rows\" | \"searchSource\" | \"inspectorAdapters\" | \"columnsMeta\" | \"totalHitCount\"> & Pick<",
|
|
"SerializableSavedSearch",
|
|
", \"serializedSearchSource\"> & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.SerializedTitles",
|
|
"text": "SerializedTitles"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.SerializedTimeRange",
|
|
"text": "SerializedTimeRange"
|
|
},
|
|
" & Partial<",
|
|
"DynamicActionsSerializedState",
|
|
"> & { rawSavedObjectAttributes?: Partial<Pick<",
|
|
"SavedSearchAttributes",
|
|
", keyof ",
|
|
"SavedSearchAttributes",
|
|
">> | undefined; savedObjectTitle?: string | undefined; savedObjectId?: string | undefined; savedObjectDescription?: string | undefined; nonPersistedDisplayOptions?: ",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-public.NonPersistedDisplayOptions",
|
|
"text": "NonPersistedDisplayOptions"
|
|
},
|
|
" | undefined; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.SearchEmbeddableSerializedState",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SearchEmbeddableSerializedState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.SerializedTitles",
|
|
"text": "SerializedTitles"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.SerializedTimeRange",
|
|
"text": "SerializedTimeRange"
|
|
},
|
|
" & Partial<",
|
|
"DynamicActionsSerializedState",
|
|
"> & Partial<Pick<",
|
|
"SavedSearchAttributes",
|
|
", keyof ",
|
|
"SavedSearchAttributes",
|
|
">> & { attributes?: (",
|
|
"SavedSearchAttributes",
|
|
" & { references: ",
|
|
"SavedObjectReference",
|
|
"[] | undefined; }) | undefined; savedObjectId?: string | undefined; nonPersistedDisplayOptions?: ",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "public",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-public.NonPersistedDisplayOptions",
|
|
"text": "NonPersistedDisplayOptions"
|
|
},
|
|
" | undefined; }"
|
|
],
|
|
"path": "src/platform/plugins/shared/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\" | \"withDefaultActions\" | \"disabledActions\" | \"onFilter\">"
|
|
],
|
|
"path": "src/platform/plugins/shared/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/platform/plugins/shared/discover/public/types.ts",
|
|
"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/platform/plugins/shared/discover/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DiscoverStart",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/discover/public/types.ts",
|
|
"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/platform/plugins/shared/discover/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-public.DiscoverStart.DiscoverContainer",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"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/platform/plugins/shared/discover/public/types.ts",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/solutions/security/plugins/security_solution/public/timelines/components/timeline/tabs/esql/index.tsx"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-server.DiscoverServerPluginLocatorService",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DiscoverServerPluginLocatorService",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/discover/server/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-server.DiscoverServerPluginLocatorService.asScopedClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "asScopedClient",
|
|
"description": [],
|
|
"signature": [
|
|
"(req: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>) => Promise<",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "server",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-server.LocatorServiceScopedClient",
|
|
"text": "LocatorServiceScopedClient"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/server/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-server.DiscoverServerPluginLocatorService.asScopedClient.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "req",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/discover/server/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-server.LocatorServiceScopedClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LocatorServiceScopedClient",
|
|
"description": [],
|
|
"path": "src/platform/plugins/shared/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<string[] | undefined>"
|
|
],
|
|
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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<string>"
|
|
],
|
|
"path": "src/platform/plugins/shared/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/platform/plugins/shared/discover/server/locator/title_from_locator.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-server.LocatorServiceScopedClient.queryFromLocator",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "queryFromLocator",
|
|
"description": [],
|
|
"signature": [
|
|
"(params: ",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "common",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-common.DiscoverAppLocatorParams",
|
|
"text": "DiscoverAppLocatorParams"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"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/platform/plugins/shared/discover/server/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-server.LocatorServiceScopedClient.queryFromLocator.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "common",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-common.DiscoverAppLocatorParams",
|
|
"text": "DiscoverAppLocatorParams"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/server/locator/query_from_locator.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-server.LocatorServiceScopedClient.filtersFromLocator",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "filtersFromLocator",
|
|
"description": [],
|
|
"signature": [
|
|
"(params: ",
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "common",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-common.DiscoverAppLocatorParams",
|
|
"text": "DiscoverAppLocatorParams"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[]>"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/server/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-server.LocatorServiceScopedClient.filtersFromLocator.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "discover",
|
|
"scope": "common",
|
|
"docId": "kibDiscoverPluginApi",
|
|
"section": "def-common.DiscoverAppLocatorParams",
|
|
"text": "DiscoverAppLocatorParams"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/server/locator/filters_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/platform/plugins/shared/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/platform/plugins/shared/discover/server/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_locator.ts",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "fleet",
|
|
"path": "x-pack/platform/plugins/shared/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/multi_page_layout/hooks/use_get_logs_discover_link.tsx"
|
|
},
|
|
{
|
|
"plugin": "osquery",
|
|
"path": "x-pack/platform/plugins/shared/osquery/public/packs/pack_queries_status_table.tsx"
|
|
},
|
|
{
|
|
"plugin": "osquery",
|
|
"path": "x-pack/platform/plugins/shared/osquery/public/discover/view_results_in_discover.tsx"
|
|
},
|
|
{
|
|
"plugin": "osquery",
|
|
"path": "x-pack/platform/plugins/shared/osquery/public/common/hooks/use_discover_link.tsx"
|
|
},
|
|
{
|
|
"plugin": "exploratoryView",
|
|
"path": "x-pack/solutions/observability/plugins/exploratory_view/public/components/shared/exploratory_view/hooks/use_discover_link.tsx"
|
|
},
|
|
{
|
|
"plugin": "synthetics",
|
|
"path": "x-pack/solutions/observability/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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_locator.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-common.DiscoverAppLocatorParams.grid",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "grid",
|
|
"description": [
|
|
"\nData Grid related state"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedSearch",
|
|
"scope": "common",
|
|
"docId": "kibSavedSearchPluginApi",
|
|
"section": "def-common.DiscoverGridSettings",
|
|
"text": "DiscoverGridSettings"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_locator.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-common.MainHistoryLocationState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "MainHistoryLocationState",
|
|
"description": [
|
|
"\nLocation state of scoped history (history instance of Kibana Platform application service)"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/common/app_locator.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-common.MainHistoryLocationState.dataViewSpec",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataViewSpec",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewSpec",
|
|
"text": "DataViewSpec"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/common/app_locator.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-common.MainHistoryLocationState.isAlertResults",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isAlertResults",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-common.APP_STATE_URL_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "APP_STATE_URL_KEY",
|
|
"description": [
|
|
"\nThe query param key used to store the Discover app state in the URL"
|
|
],
|
|
"signature": [
|
|
"\"_a\""
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/common/constants.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/platform/plugins/shared/discover/common/app_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/platform/plugins/shared/discover/common/app_locator.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-common.DiscoverESQLLocator",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DiscoverESQLLocator",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "common",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-common.LocatorPublic",
|
|
"text": "LocatorPublic"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/common/esql_locator.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "discover",
|
|
"id": "def-common.DiscoverESQLLocatorParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DiscoverESQLLocatorParams",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
}
|
|
],
|
|
"path": "src/platform/plugins/shared/discover/common/esql_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/platform/plugins/shared/discover/common/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |