kibana/api_docs/kbn_discover_utils.devdocs.json

6405 lines
No EOL
242 KiB
JSON

{
"id": "@kbn/discover-utils",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuRegistry",
"type": "Class",
"tags": [],
"label": "AppMenuRegistry",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/app_menu_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuRegistry.CUSTOM_ITEMS_LIMIT",
"type": "number",
"tags": [],
"label": "CUSTOM_ITEMS_LIMIT",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/app_menu_registry.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuRegistry.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/app_menu_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuRegistry.Unnamed.$1",
"type": "Array",
"tags": [],
"label": "primaryAndSecondaryActions",
"description": [],
"signature": [
"(",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionPrimary",
"text": "AppMenuActionPrimary"
},
" | ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuItemSecondary",
"text": "AppMenuItemSecondary"
},
")[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/app_menu_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuRegistry.isActionRegistered",
"type": "Function",
"tags": [],
"label": "isActionRegistered",
"description": [],
"signature": [
"(appMenuItemId: string) => boolean"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/app_menu_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuRegistry.isActionRegistered.$1",
"type": "string",
"tags": [],
"label": "appMenuItemId",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/app_menu_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuRegistry.registerCustomAction",
"type": "Function",
"tags": [],
"label": "registerCustomAction",
"description": [
"\nRegister a custom action to the app menu. It can be a simple action or a submenu with more actions and horizontal rules.\nNote: Only 2 top level custom actions are allowed to be rendered in the app menu. The rest will be ignored.\nA custom action can also open a flyout or a modal. For that, return your custom react node from action's `onClick` event and call `onFinishAction` when you're done."
],
"signature": [
"(appMenuItem: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuItemCustom",
"text": "AppMenuItemCustom"
},
") => void"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/app_menu_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuRegistry.registerCustomAction.$1",
"type": "CompoundType",
"tags": [],
"label": "appMenuItem",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuItemCustom",
"text": "AppMenuItemCustom"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/app_menu_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuRegistry.registerCustomActionUnderSubmenu",
"type": "Function",
"tags": [],
"label": "registerCustomActionUnderSubmenu",
"description": [
"\nRegister a custom action under a submenu. It can be an action or a horizontal rule.\nAny number of submenu actions can be registered and rendered.\nYou can also extend an existing submenu with more actions. For example, AppMenuActionType.alerts.\n`order` property is optional and can be used to control the order of actions in the submenu."
],
"signature": [
"(submenuId: string, appMenuItem: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuSubmenuActionCustom",
"text": "AppMenuSubmenuActionCustom"
},
" | ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuSubmenuHorizontalRule",
"text": "AppMenuSubmenuHorizontalRule"
},
") => void"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/app_menu_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuRegistry.registerCustomActionUnderSubmenu.$1",
"type": "string",
"tags": [],
"label": "submenuId",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/app_menu_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuRegistry.registerCustomActionUnderSubmenu.$2",
"type": "CompoundType",
"tags": [],
"label": "appMenuItem",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuSubmenuActionCustom",
"text": "AppMenuSubmenuActionCustom"
},
" | ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuSubmenuHorizontalRule",
"text": "AppMenuSubmenuHorizontalRule"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/app_menu_registry.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuRegistry.getSortedItems",
"type": "Function",
"tags": [],
"label": "getSortedItems",
"description": [
"\nGet the resulting app menu items sorted by type and order."
],
"signature": [
"() => ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuItem",
"text": "AppMenuItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/app_menu_registry.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.buildDataTableRecord",
"type": "Function",
"tags": [],
"label": "buildDataTableRecord",
"description": [
"\nBuild a record for data grid"
],
"signature": [
"(doc: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.EsHitRecord",
"text": "EsHitRecord"
},
", dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined, isAnchor: boolean | undefined, options: { flattenedFieldsComparator?: ((a: string | symbol, b: string | symbol) => 0 | 1 | -1) | undefined; } | undefined) => ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/build_data_record.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.buildDataTableRecord.$1",
"type": "Object",
"tags": [],
"label": "doc",
"description": [
"the document returned from Elasticsearch"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.EsHitRecord",
"text": "EsHitRecord"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/build_data_record.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.buildDataTableRecord.$2",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [
"this current data view"
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/build_data_record.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.buildDataTableRecord.$3",
"type": "CompoundType",
"tags": [],
"label": "isAnchor",
"description": [
"determines if the given doc is the anchor doc when viewing surrounding documents"
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/build_data_record.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.buildDataTableRecord.$4",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/build_data_record.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.buildDataTableRecord.$4.flattenedFieldsComparator",
"type": "Function",
"tags": [],
"label": "flattenedFieldsComparator",
"description": [],
"signature": [
"((a: string | symbol, b: string | symbol) => 0 | 1 | -1) | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/build_data_record.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.buildDataTableRecordList",
"type": "Function",
"tags": [],
"label": "buildDataTableRecordList",
"description": [
"\nHelper to build multiple DataTableRecords at once, saved a bit of testing code lines"
],
"signature": [
"({\n records,\n dataView,\n processRecord,\n}: { records: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.EsHitRecord",
"text": "EsHitRecord"
},
"[]; dataView?: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined; processRecord?: ((record: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
") => T) | undefined; }) => ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/build_data_record.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.buildDataTableRecordList.$1",
"type": "Object",
"tags": [],
"label": "{\n records,\n dataView,\n processRecord,\n}",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/build_data_record.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.buildDataTableRecordList.$1.records",
"type": "Array",
"tags": [],
"label": "records",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.EsHitRecord",
"text": "EsHitRecord"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/build_data_record.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.buildDataTableRecordList.$1.dataView",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/build_data_record.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.buildDataTableRecordList.$1.processRecord",
"type": "Function",
"tags": [],
"label": "processRecord",
"description": [],
"signature": [
"((record: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
") => T) | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/build_data_record.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.buildDataTableRecordList.$1.processRecord.$1",
"type": "Object",
"tags": [],
"label": "record",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/build_data_record.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.calcFieldCounts",
"type": "Function",
"tags": [],
"label": "calcFieldCounts",
"description": [
"\nThis function is calculating stats of the available fields, for usage in sidebar and sharing\nNote that this values aren't displayed, but used for internal calculations"
],
"signature": [
"(rows: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
"[] | undefined) => Record<string, number>"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/calc_field_counts.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.calcFieldCounts.$1",
"type": "Array",
"tags": [],
"label": "rows",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
"[] | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/calc_field_counts.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.canPrependTimeFieldColumn",
"type": "Function",
"tags": [],
"label": "canPrependTimeFieldColumn",
"description": [],
"signature": [
"(columns: string[] | undefined, timeFieldName: string | undefined, columnsMeta: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableColumnsMeta",
"text": "DataTableColumnsMeta"
},
" | undefined, showTimeCol: boolean, isESQLMode: boolean) => boolean"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_visible_columns.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.canPrependTimeFieldColumn.$1",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_visible_columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.canPrependTimeFieldColumn.$2",
"type": "string",
"tags": [],
"label": "timeFieldName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_visible_columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.canPrependTimeFieldColumn.$3",
"type": "Object",
"tags": [],
"label": "columnsMeta",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableColumnsMeta",
"text": "DataTableColumnsMeta"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_visible_columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.canPrependTimeFieldColumn.$4",
"type": "boolean",
"tags": [],
"label": "showTimeCol",
"description": [],
"signature": [
"boolean"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_visible_columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.canPrependTimeFieldColumn.$5",
"type": "boolean",
"tags": [],
"label": "isESQLMode",
"description": [],
"signature": [
"boolean"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_visible_columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.createDegradedDocsControl",
"type": "Function",
"tags": [],
"label": "createDegradedDocsControl",
"description": [
"\nDegraded docs control factory function."
],
"signature": [
"(props?: DegradedDocsControlProps | undefined) => ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.RowControlColumn",
"text": "RowControlColumn"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/degraded_docs_control.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.createDegradedDocsControl.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [
"Optional props for the generated Control component, useful to override onClick, etc"
],
"signature": [
"DegradedDocsControlProps | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/degraded_docs_control.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.createLogsContextService",
"type": "Function",
"tags": [],
"label": "createLogsContextService",
"description": [],
"signature": [
"({ logsDataAccess, }: ",
"LogsContextServiceDeps",
") => Promise<",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogsContextService",
"text": "LogsContextService"
},
">"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/logs_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.createLogsContextService.$1",
"type": "Object",
"tags": [],
"label": "{\n logsDataAccess,\n}",
"description": [],
"signature": [
"LogsContextServiceDeps"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/logs_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.createStacktraceControl",
"type": "Function",
"tags": [],
"label": "createStacktraceControl",
"description": [
"\nStacktrace control factory function."
],
"signature": [
"(props?: Partial<",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.RowControlProps",
"text": "RowControlProps"
},
"> | undefined) => ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.RowControlColumn",
"text": "RowControlColumn"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/stacktrace_control.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.createStacktraceControl.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [
"Optional props for the generated Control component, useful to override onClick, etc"
],
"signature": [
"Partial<",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.RowControlProps",
"text": "RowControlProps"
},
"> | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/stacktrace_control.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.createTracesContextService",
"type": "Function",
"tags": [],
"label": "createTracesContextService",
"description": [],
"signature": [
"({ apmSourcesAccess, }: ",
"TracesContextServiceDeps",
") => Promise<",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.TracesContextService",
"text": "TracesContextService"
},
">"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/traces/traces_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.createTracesContextService.$1",
"type": "Object",
"tags": [],
"label": "{\n apmSourcesAccess,\n}",
"description": [],
"signature": [
"TracesContextServiceDeps"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/traces/traces_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.dismissAllFlyoutsExceptFor",
"type": "Function",
"tags": [],
"label": "dismissAllFlyoutsExceptFor",
"description": [],
"signature": [
"(excludedFlyout: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DiscoverFlyouts",
"text": "DiscoverFlyouts"
},
") => void"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/dismiss_flyouts.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.dismissAllFlyoutsExceptFor.$1",
"type": "Enum",
"tags": [],
"label": "excludedFlyout",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DiscoverFlyouts",
"text": "DiscoverFlyouts"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/dismiss_flyouts.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.dismissFlyouts",
"type": "Function",
"tags": [],
"label": "dismissFlyouts",
"description": [],
"signature": [
"(selectedFlyouts?: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DiscoverFlyouts",
"text": "DiscoverFlyouts"
},
"[], excludedFlyout?: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DiscoverFlyouts",
"text": "DiscoverFlyouts"
},
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/dismiss_flyouts.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.dismissFlyouts.$1",
"type": "Array",
"tags": [],
"label": "selectedFlyouts",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DiscoverFlyouts",
"text": "DiscoverFlyouts"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/dismiss_flyouts.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.dismissFlyouts.$2",
"type": "CompoundType",
"tags": [],
"label": "excludedFlyout",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DiscoverFlyouts",
"text": "DiscoverFlyouts"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/dismiss_flyouts.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatFieldValue",
"type": "Function",
"tags": [],
"label": "formatFieldValue",
"description": [
"\nFormats the value of a specific field using the appropriate field formatter if available\nor the default string field formatter otherwise.\n"
],
"signature": [
"(value: unknown, hit: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.EsHitRecord",
"text": "EsHitRecord"
},
", fieldFormats: ",
{
"pluginId": "fieldFormats",
"scope": "public",
"docId": "kibFieldFormatsPluginApi",
"section": "def-public.FieldFormatsStart",
"text": "FieldFormatsStart"
},
", dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined, field: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
" | undefined, contentType: ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
},
" | undefined, options: ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.TextContextTypeOptions",
"text": "TextContextTypeOptions"
},
" | ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.HtmlContextTypeOptions",
"text": "HtmlContextTypeOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_value.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatFieldValue.$1",
"type": "Unknown",
"tags": [],
"label": "value",
"description": [
"The value to format"
],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_value.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatFieldValue.$2",
"type": "Object",
"tags": [],
"label": "hit",
"description": [
"The actual search hit (required to get highlight information from)"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.EsHitRecord",
"text": "EsHitRecord"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_value.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatFieldValue.$3",
"type": "CompoundType",
"tags": [],
"label": "fieldFormats",
"description": [
"Field formatters"
],
"signature": [
{
"pluginId": "fieldFormats",
"scope": "public",
"docId": "kibFieldFormatsPluginApi",
"section": "def-public.FieldFormatsStart",
"text": "FieldFormatsStart"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_value.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatFieldValue.$4",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [
"The data view if available"
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_value.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatFieldValue.$5",
"type": "Object",
"tags": [],
"label": "field",
"description": [
"The field that value was from if available"
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_value.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatFieldValue.$6",
"type": "CompoundType",
"tags": [],
"label": "contentType",
"description": [
"Type of a converter"
],
"signature": [
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_value.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatFieldValue.$7",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [
"Options for the converter"
],
"signature": [
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.TextContextTypeOptions",
"text": "TextContextTypeOptions"
},
" | ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.HtmlContextTypeOptions",
"text": "HtmlContextTypeOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_value.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"An sanitized HTML string, that is safe to be applied via dangerouslySetInnerHTML"
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatHit",
"type": "Function",
"tags": [],
"label": "formatHit",
"description": [
"\nReturns a formatted document in form of key/value pairs of the fields name and a formatted value.\nThe value returned in each pair is an HTML string which is safe to be applied to the DOM, since\nit's formatted using field formatters."
],
"signature": [
"(hit: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
", dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
", shouldShowFieldHandler: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.ShouldShowFieldInTableHandler",
"text": "ShouldShowFieldInTableHandler"
},
", maxEntries: number, fieldFormats: ",
{
"pluginId": "fieldFormats",
"scope": "public",
"docId": "kibFieldFormatsPluginApi",
"section": "def-public.FieldFormatsStart",
"text": "FieldFormatsStart"
},
") => ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.FormattedHit",
"text": "FormattedHit"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_hit.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatHit.$1",
"type": "Object",
"tags": [],
"label": "hit",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_hit.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatHit.$2",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_hit.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatHit.$3",
"type": "Function",
"tags": [],
"label": "shouldShowFieldHandler",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.ShouldShowFieldInTableHandler",
"text": "ShouldShowFieldInTableHandler"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_hit.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatHit.$4",
"type": "number",
"tags": [],
"label": "maxEntries",
"description": [],
"signature": [
"number"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_hit.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.formatHit.$5",
"type": "CompoundType",
"tags": [],
"label": "fieldFormats",
"description": [],
"signature": [
{
"pluginId": "fieldFormats",
"scope": "public",
"docId": "kibFieldFormatsPluginApi",
"section": "def-public.FieldFormatsStart",
"text": "FieldFormatsStart"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/format_hit.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getDocId",
"type": "Function",
"tags": [],
"label": "getDocId",
"description": [
"\nReturning a generated id of a given ES document, since `_id` can be the same\nwhen using different indices and shard routing"
],
"signature": [
"(doc: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.EsHitRecord",
"text": "EsHitRecord"
},
" & { _routing?: string | undefined; }) => string"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_doc_id.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getDocId.$1",
"type": "CompoundType",
"tags": [],
"label": "doc",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.EsHitRecord",
"text": "EsHitRecord"
},
" & { _routing?: string | undefined; }"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_doc_id.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getFieldValue",
"type": "Function",
"tags": [],
"label": "getFieldValue",
"description": [],
"signature": [
"<TRecord extends ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
", TField extends string>(record: TRecord, field: TField & keyof TRecord[\"flattened\"]) => TRecord[\"flattened\"][TField]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_field_value.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getFieldValue.$1",
"type": "Uncategorized",
"tags": [],
"label": "record",
"description": [],
"signature": [
"TRecord"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_field_value.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getFieldValue.$2",
"type": "CompoundType",
"tags": [],
"label": "field",
"description": [],
"signature": [
"TField & keyof TRecord[\"flattened\"]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_field_value.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getIgnoredReason",
"type": "Function",
"tags": [],
"label": "getIgnoredReason",
"description": [
"\nReturns the reason why a specific field was ignored in the response.\nWill return undefined if the field had no ignored values in it.\nThis implementation will make some assumptions based on specific types\nof ignored values can only happen with specific field types in Elasticsearch.\n"
],
"signature": [
"(field: string | ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
", ignoredFields: string[] | undefined) => ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.IgnoredReason",
"text": "IgnoredReason"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_ignored_reason.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getIgnoredReason.$1",
"type": "CompoundType",
"tags": [],
"label": "field",
"description": [
"Either the data view field or the string name of it."
],
"signature": [
"string | ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_ignored_reason.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getIgnoredReason.$2",
"type": "Array",
"tags": [],
"label": "ignoredFields",
"description": [
"The hit._ignored value of the hit to validate."
],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_ignored_reason.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getLogDocumentOverview",
"type": "Function",
"tags": [],
"label": "getLogDocumentOverview",
"description": [],
"signature": [
"(doc: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
", { dataView, fieldFormats }: { dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"; fieldFormats: ",
{
"pluginId": "fieldFormats",
"scope": "public",
"docId": "kibFieldFormatsPluginApi",
"section": "def-public.FieldFormatsStart",
"text": "FieldFormatsStart"
},
"; }) => ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogDocumentOverview",
"text": "LogDocumentOverview"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_log_document_overview.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getLogDocumentOverview.$1",
"type": "Object",
"tags": [],
"label": "doc",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_log_document_overview.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getLogDocumentOverview.$2",
"type": "Object",
"tags": [],
"label": "{ dataView, fieldFormats }",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_log_document_overview.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getLogDocumentOverview.$2.dataView",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_log_document_overview.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getLogDocumentOverview.$2.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/packages/shared/kbn-discover-utils/src/utils/get_log_document_overview.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getLogLevelCoalescedValue",
"type": "Function",
"tags": [],
"label": "getLogLevelCoalescedValue",
"description": [],
"signature": [
"(logLevel: unknown) => ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogLevelCoalescedValue",
"text": "LogLevelCoalescedValue"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/utils/get_log_level_coalesed_value.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getLogLevelCoalescedValue.$1",
"type": "Unknown",
"tags": [],
"label": "logLevel",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/utils/get_log_level_coalesed_value.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getLogLevelCoalescedValueLabel",
"type": "Function",
"tags": [],
"label": "getLogLevelCoalescedValueLabel",
"description": [],
"signature": [
"(coalescedValue: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogLevelCoalescedValue",
"text": "LogLevelCoalescedValue"
},
") => string"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/utils/get_log_level_coalesed_value.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getLogLevelCoalescedValueLabel.$1",
"type": "Enum",
"tags": [],
"label": "coalescedValue",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogLevelCoalescedValue",
"text": "LogLevelCoalescedValue"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/utils/get_log_level_coalesed_value.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getLogLevelColor",
"type": "Function",
"tags": [],
"label": "getLogLevelColor",
"description": [],
"signature": [
"(logLevelCoalescedValue: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogLevelCoalescedValue",
"text": "LogLevelCoalescedValue"
},
", euiTheme: ",
"EuiThemeComputed",
"<{}>) => string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/utils/get_log_level_color.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getLogLevelColor.$1",
"type": "Enum",
"tags": [],
"label": "logLevelCoalescedValue",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogLevelCoalescedValue",
"text": "LogLevelCoalescedValue"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/utils/get_log_level_color.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getLogLevelColor.$2",
"type": "CompoundType",
"tags": [],
"label": "euiTheme",
"description": [],
"signature": [
"EuiThemeComputed",
"<{}>"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/utils/get_log_level_color.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getMessageFieldWithFallbacks",
"type": "Function",
"tags": [],
"label": "getMessageFieldWithFallbacks",
"description": [],
"signature": [
"(doc: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogDocumentOverview",
"text": "LogDocumentOverview"
},
", { includeFormattedValue }?: { includeFormattedValue?: boolean | undefined; }) => { field: \"message\" | \"event.original\" | \"error.message\"; value: string; formattedValue: string | undefined; } | { field: undefined; value?: undefined; formattedValue?: undefined; }"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_message_field_with_fallbacks.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getMessageFieldWithFallbacks.$1",
"type": "Object",
"tags": [],
"label": "doc",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogDocumentOverview",
"text": "LogDocumentOverview"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_message_field_with_fallbacks.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getMessageFieldWithFallbacks.$2",
"type": "Object",
"tags": [],
"label": "{ includeFormattedValue = false }",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_message_field_with_fallbacks.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getMessageFieldWithFallbacks.$2.includeFormattedValue",
"type": "CompoundType",
"tags": [],
"label": "includeFormattedValue",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_message_field_with_fallbacks.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getShouldShowFieldHandler",
"type": "Function",
"tags": [],
"label": "getShouldShowFieldHandler",
"description": [
"\nReturns a function for checking whether we should display a field in the Documents column of the data table\nIf showMultiFields is set to false, it filters out multifields that have a parent, to prevent entries for multifields\nlike this: field, field.keyword, field.whatever"
],
"signature": [
"(fields: string[], dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
", showMultiFields: boolean) => ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.ShouldShowFieldInTableHandler",
"text": "ShouldShowFieldInTableHandler"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_should_show_field_handler.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getShouldShowFieldHandler.$1",
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_should_show_field_handler.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getShouldShowFieldHandler.$2",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_should_show_field_handler.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getShouldShowFieldHandler.$3",
"type": "boolean",
"tags": [],
"label": "showMultiFields",
"description": [],
"signature": [
"boolean"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_should_show_field_handler.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getTraceDocumentOverview",
"type": "Function",
"tags": [],
"label": "getTraceDocumentOverview",
"description": [],
"signature": [
"(doc: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
") => ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.TraceDocumentOverview",
"text": "TraceDocumentOverview"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_trace_document_overview.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getTraceDocumentOverview.$1",
"type": "Object",
"tags": [],
"label": "doc",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_trace_document_overview.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getVisibleColumns",
"type": "Function",
"tags": [],
"label": "getVisibleColumns",
"description": [],
"signature": [
"(columns: string[], dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
", shouldPrependTimeFieldColumn: boolean) => string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_visible_columns.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getVisibleColumns.$1",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_visible_columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getVisibleColumns.$2",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_visible_columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.getVisibleColumns.$3",
"type": "boolean",
"tags": [],
"label": "shouldPrependTimeFieldColumn",
"description": [],
"signature": [
"boolean"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_visible_columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.isNestedFieldParent",
"type": "Function",
"tags": [],
"label": "isNestedFieldParent",
"description": [
"\nThis function checks if the given field in a given data view is a nested field's parent.\nDiscover doesn't flatten arrays of objects, so for documents with an `object` or `nested` field that\ncontains an array, Discover will only detect the top level root field. We want to detect when those\nroot fields are `nested` so that we can display the proper icon and label. However, those root\n`nested` fields are not a part of the data view. Their children are though, and contain nested path\ninfo. So to detect nested fields we look through the data view for nested children\nwhose path begins with the current field. There are edge cases where\nthis could incorrectly identify a plain `object` field as `nested`. Say we had the following document\nwhere `foo` is a plain object field and `bar` is a nested field.\n{\n \"foo\": [\n {\n \"bar\": [\n {\n \"baz\": \"qux\"\n }\n ]\n },\n {\n \"bar\": [\n {\n \"baz\": \"qux\"\n }\n ]\n }\n]\n}\nThe following code will search for `foo`, find it at the beginning of the path to the nested child field\n`foo.bar.baz` and incorrectly mark `foo` as nested. Any time we're searching for the name of a plain object\nfield that happens to match a segment of a nested path, we'll get a false positive.\nWe're aware of this issue and we'll have to live with\nit in the short term. The long term fix will be to add info about the `nested` and `object` root fields\nto the data view, but that has its own complications which you can read more about in the following\nissue: https://github.com/elastic/kibana/issues/54957"
],
"signature": [
"(fieldName: string, dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
") => boolean"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/nested_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.isNestedFieldParent.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/nested_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.isNestedFieldParent.$2",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/nested_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogLevelBadge",
"type": "Function",
"tags": [],
"label": "LogLevelBadge",
"description": [],
"signature": [
"({ logLevel, fallback, \"data-test-subj\": dataTestSubj, ...badgeProps }: Omit<",
"EuiBadgeProps",
", \"color\" | \"children\"> & { logLevel: {}; fallback?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined; }) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/components/log_level_badge.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogLevelBadge.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n logLevel,\n fallback,\n 'data-test-subj': dataTestSubj = 'logLevelBadge',\n ...badgeProps\n}",
"description": [],
"signature": [
"Omit<",
"EuiBadgeProps",
", \"color\" | \"children\"> & { logLevel: {}; fallback?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined; }"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/components/log_level_badge.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.usePager",
"type": "Function",
"tags": [],
"label": "usePager",
"description": [],
"signature": [
"({ initialPageSize, totalItems, }: { totalItems: number; initialPageSize: number; }) => { curPageIndex: number; pageSize: number; changePageIndex: (pageIndex: number) => void; changePageSize: (newPageSize: number) => void; totalPages: number; startIndex: number; hasNextPage: boolean; }"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/hooks/use_pager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.usePager.$1",
"type": "Object",
"tags": [],
"label": "{\n initialPageSize,\n totalItems,\n}",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/hooks/use_pager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.usePager.$1.totalItems",
"type": "number",
"tags": [],
"label": "totalItems",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/hooks/use_pager.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.usePager.$1.initialPageSize",
"type": "number",
"tags": [],
"label": "initialPageSize",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/hooks/use_pager.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionBase",
"type": "Interface",
"tags": [],
"label": "AppMenuActionBase",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionBase.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionBase.order",
"type": "number",
"tags": [],
"label": "order",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionCustom",
"type": "Interface",
"tags": [],
"label": "AppMenuActionCustom",
"description": [
"\nA custom menu action"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionCustom",
"text": "AppMenuActionCustom"
},
" extends ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionBase",
"text": "AppMenuActionBase"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionCustom.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionType",
"text": "AppMenuActionType"
},
".custom"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionCustom.controlProps",
"type": "CompoundType",
"tags": [],
"label": "controlProps",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuData",
"text": "TopNavMenuData"
},
", \"label\" | \"description\" | \"href\" | \"tooltip\" | \"isLoading\" | \"testId\" | \"disableButton\"> & { onClick: ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => Promise<void | React.ReactNode>) | ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => void | React.ReactNode) | undefined; }"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionPrimary",
"type": "Interface",
"tags": [],
"label": "AppMenuActionPrimary",
"description": [
"\nA primary menu action (with icon only)"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionPrimary",
"text": "AppMenuActionPrimary"
},
" extends ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionBase",
"text": "AppMenuActionBase"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionPrimary.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionType",
"text": "AppMenuActionType"
},
".primary"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionPrimary.controlProps",
"type": "CompoundType",
"tags": [],
"label": "controlProps",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuData",
"text": "TopNavMenuData"
},
", \"label\" | \"description\" | \"href\" | \"tooltip\" | \"isLoading\" | \"testId\" | \"disableButton\"> & { onClick: ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => Promise<void | React.ReactNode>) | ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => void | React.ReactNode) | undefined; } & { iconType: \"string\" | \"number\" | \"function\" | \"key\" | \"namespace\" | \"error\" | \"filter\" | \"search\" | \"link\" | \"at\" | \"nested\" | \"ip\" | \"push\" | \"list\" | \"cluster\" | \"eql\" | \"index\" | \"unlink\" | \"alert\" | \"color\" | \"grid\" | \"aggregate\" | \"code\" | \"warning\" | \"annotation\" | \"stats\" | \"mobile\" | \"article\" | \"menu\" | \"section\" | \"image\" | \"stop\" | \"download\" | \"document\" | \"email\" | \"copy\" | \"move\" | \"merge\" | \"partial\" | \"container\" | \"user\" | \"pause\" | \"share\" | \"home\" | \"spaces\" | \"package\" | \"endpoint\" | \"tag\" | \"beta\" | \"users\" | \"accessibility\" | \"addDataApp\" | \"advancedSettingsApp\" | \"agentApp\" | \"analyzeEvent\" | \"anomalyChart\" | \"anomalySwimLane\" | \"apmApp\" | \"apmTrace\" | \"appSearchApp\" | \"apps\" | \"arrowDown\" | \"arrowLeft\" | \"arrowRight\" | \"arrowUp\" | \"arrowStart\" | \"arrowEnd\" | \"asterisk\" | \"auditbeatApp\" | \"beaker\" | \"bell\" | \"bellSlash\" | \"bolt\" | \"boxesHorizontal\" | \"boxesVertical\" | \"branch\" | \"branchUser\" | \"broom\" | \"brush\" | \"bug\" | \"bullseye\" | \"calendar\" | \"canvasApp\" | \"casesApp\" | \"changePointDetection\" | \"check\" | \"checkCircle\" | \"checkInCircleFilled\" | \"cheer\" | \"classificationJob\" | \"clickLeft\" | \"clickRight\" | \"clock\" | \"clockCounter\" | \"cloudDrizzle\" | \"cloudStormy\" | \"cloudSunny\" | \"codeApp\" | \"compute\" | \"console\" | \"consoleApp\" | \"continuityAbove\" | \"continuityAboveBelow\" | \"continuityBelow\" | \"continuityWithin\" | \"contrast\" | \"contrastHigh\" | \"controlsHorizontal\" | \"controlsVertical\" | \"copyClipboard\" | \"createAdvancedJob\" | \"createGenericJob\" | \"createGeoJob\" | \"createMultiMetricJob\" | \"createPopulationJob\" | \"createSingleMetricJob\" | \"cross\" | \"crossClusterReplicationApp\" | \"crossInCircle\" | \"crosshairs\" | \"currency\" | \"cut\" | \"dashboardApp\" | \"dataVisualizer\" | \"database\" | \"desktop\" | \"devToolsApp\" | \"diff\" | \"discoverApp\" | \"discuss\" | \"documentEdit\" | \"documentation\" | \"documents\" | \"dot\" | \"dotInCircle\" | \"doubleArrowLeft\" | \"doubleArrowRight\" | \"editorAlignCenter\" | \"editorAlignLeft\" | \"editorAlignRight\" | \"editorBold\" | \"editorChecklist\" | \"editorCodeBlock\" | \"editorComment\" | \"editorDistributeHorizontal\" | \"editorDistributeVertical\" | \"editorHeading\" | \"editorItalic\" | \"editorItemAlignBottom\" | \"editorItemAlignCenter\" | \"editorItemAlignLeft\" | \"editorItemAlignMiddle\" | \"editorItemAlignRight\" | \"editorItemAlignTop\" | \"editorLink\" | \"editorOrderedList\" | \"editorPositionBottomLeft\" | \"editorPositionBottomRight\" | \"editorPositionTopLeft\" | \"editorPositionTopRight\" | \"editorRedo\" | \"editorStrike\" | \"editorTable\" | \"editorUnderline\" | \"editorUndo\" | \"editorUnorderedList\" | \"empty\" | \"emsApp\" | \"eraser\" | \"errorFilled\" | \"esqlVis\" | \"exit\" | \"expand\" | \"expandMini\" | \"exportAction\" | \"eye\" | \"eyeClosed\" | \"faceHappy\" | \"faceNeutral\" | \"faceSad\" | \"fieldStatistics\" | \"filebeatApp\" | \"filterExclude\" | \"filterIgnore\" | \"filterInclude\" | \"filterInCircle\" | \"flag\" | \"fleetApp\" | \"fold\" | \"folderCheck\" | \"folderClosed\" | \"folderExclamation\" | \"folderOpen\" | \"frameNext\" | \"framePrevious\" | \"fullScreen\" | \"fullScreenExit\" | \"gear\" | \"gisApp\" | \"glasses\" | \"globe\" | \"grab\" | \"grabHorizontal\" | \"grabOmnidirectional\" | \"gradient\" | \"graphApp\" | \"grokApp\" | \"heart\" | \"heartbeatApp\" | \"heatmap\" | \"help\" | \"iInCircle\" | \"importAction\" | \"indexClose\" | \"indexEdit\" | \"indexFlush\" | \"indexManagementApp\" | \"indexMapping\" | \"indexOpen\" | \"indexPatternApp\" | \"indexRollupApp\" | \"indexRuntime\" | \"indexSettings\" | \"indexTemporary\" | \"infinity\" | \"inputOutput\" | \"inspect\" | \"invert\" | \"keyboard\" | \"kqlField\" | \"kqlFunction\" | \"kqlOperand\" | \"kqlSelector\" | \"kqlValue\" | \"kubernetesNode\" | \"kubernetesPod\" | \"launch\" | \"layers\" | \"lensApp\" | \"lettering\" | \"lineDashed\" | \"lineDotted\" | \"lineSolid\" | \"listAdd\" | \"lock\" | \"lockOpen\" | \"logPatternAnalysis\" | \"logRateAnalysis\" | \"logoAWS\" | \"logoAWSMono\" | \"logoAerospike\" | \"logoApache\" | \"logoAppSearch\" | \"logoAzure\" | \"logoAzureMono\" | \"logoBeats\" | \"logoBusinessAnalytics\" | \"logoCeph\" | \"logoCloud\" | \"logoCloudEnterprise\" | \"logoCode\" | \"logoCodesandbox\" | \"logoCouchbase\" | \"logoDocker\" | \"logoDropwizard\" | \"logoElastic\" | \"logoElasticStack\" | \"logoElasticsearch\" | \"logoEnterpriseSearch\" | \"logoEtcd\" | \"logoGCP\" | \"logoGCPMono\" | \"logoGithub\" | \"logoGmail\" | \"logoGolang\" | \"logoGoogleG\" | \"logoHAproxy\" | \"logoIBM\" | \"logoIBMMono\" | \"logoKafka\" | \"logoKibana\" | \"logoKubernetes\" | \"logoLogging\" | \"logoLogstash\" | \"logoMaps\" | \"logoMemcached\" | \"logoMetrics\" | \"logoMongodb\" | \"logoMySQL\" | \"logoNginx\" | \"logoObservability\" | \"logoOsquery\" | \"logoPhp\" | \"logoPostgres\" | \"logoPrometheus\" | \"logoRabbitmq\" | \"logoRedis\" | \"logoSecurity\" | \"logoSiteSearch\" | \"logoSketch\" | \"logoSlack\" | \"logoUptime\" | \"logoVulnerabilityManagement\" | \"logoWebhook\" | \"logoWindows\" | \"logoWorkplaceSearch\" | \"logsApp\" | \"logstashFilter\" | \"logstashIf\" | \"logstashInput\" | \"logstashOutput\" | \"logstashQueue\" | \"machineLearningApp\" | \"magnet\" | \"magnifyWithExclamation\" | \"magnifyWithMinus\" | \"magnifyWithPlus\" | \"managementApp\" | \"mapMarker\" | \"memory\" | \"menuDown\" | \"menuLeft\" | \"menuRight\" | \"menuUp\" | \"metricbeatApp\" | \"metricsApp\" | \"minimize\" | \"minus\" | \"minusInCircle\" | \"minusInCircleFilled\" | \"minusInSquare\" | \"monitoringApp\" | \"moon\" | \"newChat\" | \"node\" | \"notebookApp\" | \"offline\" | \"online\" | \"outlierDetectionJob\" | \"packetbeatApp\" | \"pageSelect\" | \"pagesSelect\" | \"palette\" | \"paperClip\" | \"payment\" | \"pencil\" | \"percent\" | \"pin\" | \"pinFilled\" | \"pipeBreaks\" | \"pipelineApp\" | \"pipeNoBreaks\" | \"pivot\" | \"play\" | \"playFilled\" | \"plugs\" | \"plus\" | \"plusInCircle\" | \"plusInCircleFilled\" | \"plusInSquare\" | \"popout\" | \"questionInCircle\" | \"quote\" | \"recentlyViewedApp\" | \"refresh\" | \"regressionJob\" | \"reporter\" | \"reportingApp\" | \"returnKey\" | \"save\" | \"savedObjectsApp\" | \"scale\" | \"searchProfilerApp\" | \"securityAnalyticsApp\" | \"securityApp\" | \"securitySignal\" | \"securitySignalDetected\" | \"securitySignalResolved\" | \"sessionViewer\" | \"shard\" | \"singleMetricViewer\" | \"snowflake\" | \"sortAscending\" | \"sortDescending\" | \"sortDown\" | \"sortLeft\" | \"sortRight\" | \"sortUp\" | \"sortable\" | \"spacesApp\" | \"sparkles\" | \"sqlApp\" | \"starEmpty\" | \"starEmptySpace\" | \"starFilled\" | \"starFilledSpace\" | \"starMinusEmpty\" | \"starMinusFilled\" | \"starPlusEmpty\" | \"starPlusFilled\" | \"stopFilled\" | \"stopSlash\" | \"storage\" | \"submodule\" | \"sun\" | \"swatchInput\" | \"symlink\" | \"tableDensityCompact\" | \"tableDensityExpanded\" | \"tableDensityNormal\" | \"tableOfContents\" | \"tear\" | \"temperature\" | \"timeline\" | \"timelineWithArrow\" | \"timelionApp\" | \"timeRefresh\" | \"timeslider\" | \"training\" | \"transitionLeftIn\" | \"transitionLeftOut\" | \"transitionTopIn\" | \"transitionTopOut\" | \"trash\" | \"unfold\" | \"upgradeAssistantApp\" | \"uptimeApp\" | \"userAvatar\" | \"usersRolesApp\" | \"vector\" | \"videoPlayer\" | \"visArea\" | \"visAreaStacked\" | \"visBarHorizontal\" | \"visBarHorizontalStacked\" | \"visBarVertical\" | \"visBarVerticalStacked\" | \"visGauge\" | \"visGoal\" | \"visLine\" | \"visMapCoordinate\" | \"visMapRegion\" | \"visMetric\" | \"visPie\" | \"visTable\" | \"visTagCloud\" | \"visText\" | \"visTimelion\" | \"visVega\" | \"visVisualBuilder\" | \"visualizeApp\" | \"vulnerabilityManagementApp\" | \"warningFilled\" | \"watchesApp\" | \"web\" | \"wordWrap\" | \"wordWrapDisabled\" | \"workplaceSearchApp\" | \"wrench\" | \"tokenAlias\" | \"tokenAnnotation\" | \"tokenArray\" | \"tokenBinary\" | \"tokenBoolean\" | \"tokenClass\" | \"tokenCompletionSuggester\" | \"tokenConstant\" | \"tokenDate\" | \"tokenDimension\" | \"tokenElement\" | \"tokenEnum\" | \"tokenEnumMember\" | \"tokenEvent\" | \"tokenException\" | \"tokenField\" | \"tokenFile\" | \"tokenFlattened\" | \"tokenFunction\" | \"tokenGeo\" | \"tokenHistogram\" | \"tokenInterface\" | \"tokenIP\" | \"tokenJoin\" | \"tokenKey\" | \"tokenKeyword\" | \"tokenMethod\" | \"tokenMetricCounter\" | \"tokenMetricGauge\" | \"tokenModule\" | \"tokenNamespace\" | \"tokenNested\" | \"tokenNull\" | \"tokenNumber\" | \"tokenObject\" | \"tokenOperator\" | \"tokenPackage\" | \"tokenParameter\" | \"tokenPercolator\" | \"tokenProperty\" | \"tokenRange\" | \"tokenRankFeature\" | \"tokenRankFeatures\" | \"tokenRepo\" | \"tokenSearchType\" | \"tokenSemanticText\" | \"tokenShape\" | \"tokenString\" | \"tokenStruct\" | \"tokenSymbol\" | \"tokenTag\" | \"tokenText\" | \"tokenTokenCount\" | \"tokenVariable\" | \"tokenVectorDense\" | \"tokenDenseVector\" | \"tokenVectorSparse\"; }"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionSecondary",
"type": "Interface",
"tags": [],
"label": "AppMenuActionSecondary",
"description": [
"\nA secondary menu action"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionSecondary",
"text": "AppMenuActionSecondary"
},
" extends ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionBase",
"text": "AppMenuActionBase"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionSecondary.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionType",
"text": "AppMenuActionType"
},
".secondary"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionSecondary.controlProps",
"type": "CompoundType",
"tags": [],
"label": "controlProps",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuData",
"text": "TopNavMenuData"
},
", \"label\" | \"description\" | \"href\" | \"tooltip\" | \"isLoading\" | \"testId\" | \"disableButton\"> & { onClick: ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => Promise<void | React.ReactNode>) | ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => void | React.ReactNode) | undefined; }"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionSubmenuBase",
"type": "Interface",
"tags": [],
"label": "AppMenuActionSubmenuBase",
"description": [
"\nA menu action which opens a submenu with more actions"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionSubmenuBase",
"text": "AppMenuActionSubmenuBase"
},
"<T> extends ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionBase",
"text": "AppMenuActionBase"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionSubmenuBase.type",
"type": "Uncategorized",
"tags": [],
"label": "type",
"description": [],
"signature": [
"T extends ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionSecondary",
"text": "AppMenuActionSecondary"
},
" ? ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionType",
"text": "AppMenuActionType"
},
".secondary : ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionType",
"text": "AppMenuActionType"
},
".custom"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionSubmenuBase.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionSubmenuBase.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionSubmenuBase.testId",
"type": "string",
"tags": [],
"label": "testId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionSubmenuBase.actions",
"type": "Uncategorized",
"tags": [],
"label": "actions",
"description": [],
"signature": [
"T extends ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionSecondary",
"text": "AppMenuActionSecondary"
},
" ? (",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuSubmenuActionSecondary",
"text": "AppMenuSubmenuActionSecondary"
},
" | ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuSubmenuActionCustom",
"text": "AppMenuSubmenuActionCustom"
},
" | ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuSubmenuHorizontalRule",
"text": "AppMenuSubmenuHorizontalRule"
},
")[] : (",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuSubmenuActionCustom",
"text": "AppMenuSubmenuActionCustom"
},
" | ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuSubmenuHorizontalRule",
"text": "AppMenuSubmenuHorizontalRule"
},
")[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuControlOnClickParams",
"type": "Interface",
"tags": [],
"label": "AppMenuControlOnClickParams",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuControlOnClickParams.anchorElement",
"type": "Object",
"tags": [],
"label": "anchorElement",
"description": [],
"signature": [
"HTMLElement"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuControlOnClickParams.onFinishAction",
"type": "Function",
"tags": [],
"label": "onFinishAction",
"description": [],
"signature": [
"() => void"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuSubmenuActionCustom",
"type": "Interface",
"tags": [],
"label": "AppMenuSubmenuActionCustom",
"description": [
"\nA custom submenu action"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuSubmenuActionCustom",
"text": "AppMenuSubmenuActionCustom"
},
" extends Omit<",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionCustom",
"text": "AppMenuActionCustom"
},
", \"controlProps\">"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuSubmenuActionCustom.controlProps",
"type": "CompoundType",
"tags": [],
"label": "controlProps",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuData",
"text": "TopNavMenuData"
},
", \"label\" | \"description\" | \"href\" | \"tooltip\" | \"isLoading\" | \"testId\" | \"disableButton\"> & { onClick: ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => Promise<void | React.ReactNode>) | ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => void | React.ReactNode) | undefined; } & ControlWithOptionalIcon"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuSubmenuActionSecondary",
"type": "Interface",
"tags": [],
"label": "AppMenuSubmenuActionSecondary",
"description": [
"\nA secondary submenu action"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuSubmenuActionSecondary",
"text": "AppMenuSubmenuActionSecondary"
},
" extends Omit<",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionSecondary",
"text": "AppMenuActionSecondary"
},
", \"controlProps\">"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuSubmenuActionSecondary.controlProps",
"type": "CompoundType",
"tags": [],
"label": "controlProps",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuData",
"text": "TopNavMenuData"
},
", \"label\" | \"description\" | \"href\" | \"tooltip\" | \"isLoading\" | \"testId\" | \"disableButton\"> & { onClick: ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => Promise<void | React.ReactNode>) | ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => void | React.ReactNode) | undefined; } & ControlWithOptionalIcon"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuSubmenuHorizontalRule",
"type": "Interface",
"tags": [],
"label": "AppMenuSubmenuHorizontalRule",
"description": [
"\nA horizontal rule between menu items"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuSubmenuHorizontalRule",
"text": "AppMenuSubmenuHorizontalRule"
},
" extends ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionBase",
"text": "AppMenuActionBase"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuSubmenuHorizontalRule.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionType",
"text": "AppMenuActionType"
},
".submenuHorizontalRule"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuSubmenuHorizontalRule.testId",
"type": "string",
"tags": [],
"label": "testId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DataTableRecord",
"type": "Interface",
"tags": [],
"label": "DataTableRecord",
"description": [
"\nThis is the record/row of data provided to our Data Table"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DataTableRecord.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nA unique id generated by index, id and routing of a record"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DataTableRecord.raw",
"type": "Object",
"tags": [],
"label": "raw",
"description": [
"\nThe document returned by Elasticsearch for search queries"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.EsHitRecord",
"text": "EsHitRecord"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DataTableRecord.flattened",
"type": "Object",
"tags": [],
"label": "flattened",
"description": [
"\nA flattened version of the ES doc or data provided by SQL, aggregations ..."
],
"signature": [
"{ [x: string]: unknown; }"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DataTableRecord.isAnchor",
"type": "CompoundType",
"tags": [],
"label": "isAnchor",
"description": [
"\nDetermines that the given doc is the anchor doc when rendering view surrounding docs"
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.EsHitRecord",
"type": "Interface",
"tags": [],
"label": "EsHitRecord",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.EsHitRecord",
"text": "EsHitRecord"
},
" extends Omit<DiscoverSearchHit, \"_source\" | \"_index\" | \"_id\">"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.EsHitRecord._index",
"type": "string",
"tags": [],
"label": "_index",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.EsHitRecord._id",
"type": "string",
"tags": [],
"label": "_id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.EsHitRecord._source",
"type": "Object",
"tags": [],
"label": "_source",
"description": [],
"signature": [
"Record<string, unknown> | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogCloudFields",
"type": "Interface",
"tags": [],
"label": "LogCloudFields",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogCloudFields.cloud.provider",
"type": "string",
"tags": [],
"label": "'cloud.provider'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogCloudFields.cloud.region",
"type": "string",
"tags": [],
"label": "'cloud.region'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogCloudFields.cloud.availability_zone",
"type": "string",
"tags": [],
"label": "'cloud.availability_zone'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogCloudFields.cloud.project.id",
"type": "string",
"tags": [],
"label": "'cloud.project.id'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogCloudFields.cloud.instance.id",
"type": "string",
"tags": [],
"label": "'cloud.instance.id'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogDocumentOverview",
"type": "Interface",
"tags": [],
"label": "LogDocumentOverview",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogDocumentOverview",
"text": "LogDocumentOverview"
},
" extends ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogResourceFields",
"text": "LogResourceFields"
},
",",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogStackTraceFields",
"text": "LogStackTraceFields"
},
",",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.LogCloudFields",
"text": "LogCloudFields"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogDocumentOverview.timestamp",
"type": "string",
"tags": [],
"label": "'@timestamp'",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogDocumentOverview.log.level",
"type": "string",
"tags": [],
"label": "'log.level'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogDocumentOverview.message",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogDocumentOverview.error.message",
"type": "string",
"tags": [],
"label": "'error.message'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogDocumentOverview.event.original",
"type": "string",
"tags": [],
"label": "'event.original'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogDocumentOverview.trace.id",
"type": "string",
"tags": [],
"label": "'trace.id'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogDocumentOverview.log.file.path",
"type": "string",
"tags": [],
"label": "'log.file.path'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogDocumentOverview.data_stream.namespace",
"type": "string",
"tags": [],
"label": "'data_stream.namespace'",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogDocumentOverview.data_stream.dataset",
"type": "string",
"tags": [],
"label": "'data_stream.dataset'",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogResourceFields",
"type": "Interface",
"tags": [],
"label": "LogResourceFields",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogResourceFields.host.name",
"type": "string",
"tags": [],
"label": "'host.name'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogResourceFields.service.name",
"type": "string",
"tags": [],
"label": "'service.name'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogResourceFields.agent.name",
"type": "string",
"tags": [],
"label": "'agent.name'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogResourceFields.orchestrator.cluster.name",
"type": "string",
"tags": [],
"label": "'orchestrator.cluster.name'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogResourceFields.orchestrator.cluster.id",
"type": "string",
"tags": [],
"label": "'orchestrator.cluster.id'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogResourceFields.orchestrator.resource.id",
"type": "string",
"tags": [],
"label": "'orchestrator.resource.id'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogResourceFields.orchestrator.namespace",
"type": "string",
"tags": [],
"label": "'orchestrator.namespace'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogResourceFields.container.name",
"type": "string",
"tags": [],
"label": "'container.name'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogResourceFields.container.id",
"type": "string",
"tags": [],
"label": "'container.id'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogsContextService",
"type": "Interface",
"tags": [],
"label": "LogsContextService",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/logs_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogsContextService.getAllLogsIndexPattern",
"type": "Function",
"tags": [],
"label": "getAllLogsIndexPattern",
"description": [],
"signature": [
"() => string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/logs_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogsContextService.isLogsIndexPattern",
"type": "Function",
"tags": [],
"label": "isLogsIndexPattern",
"description": [],
"signature": [
"(indexPattern: unknown) => boolean"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/logs_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogsContextService.isLogsIndexPattern.$1",
"type": "Unknown",
"tags": [],
"label": "indexPattern",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/logs_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogStackTraceFields",
"type": "Interface",
"tags": [],
"label": "LogStackTraceFields",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogStackTraceFields.error.stack_trace",
"type": "string",
"tags": [],
"label": "'error.stack_trace'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogStackTraceFields.error.exception.stacktrace",
"type": "string",
"tags": [],
"label": "'error.exception.stacktrace'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogStackTraceFields.error.log.stacktrace",
"type": "string",
"tags": [],
"label": "'error.log.stacktrace'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlColumn",
"type": "Interface",
"tags": [],
"label": "RowControlColumn",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlColumn.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlColumn.headerAriaLabel",
"type": "string",
"tags": [],
"label": "headerAriaLabel",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlColumn.headerCellRender",
"type": "CompoundType",
"tags": [],
"label": "headerCellRender",
"description": [],
"signature": [
"React.ComponentType<{}> | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlColumn.renderControl",
"type": "Function",
"tags": [],
"label": "renderControl",
"description": [],
"signature": [
"(Control: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.RowControlComponent",
"text": "RowControlComponent"
},
", props: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.RowControlRowProps",
"text": "RowControlRowProps"
},
") => React.ReactElement<any, string | React.JSXElementConstructor<any>>"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlColumn.renderControl.$1",
"type": "Function",
"tags": [],
"label": "Control",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.RowControlComponent",
"text": "RowControlComponent"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlColumn.renderControl.$2",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.RowControlRowProps",
"text": "RowControlRowProps"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlProps",
"type": "Interface",
"tags": [],
"label": "RowControlProps",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlProps.color",
"type": "CompoundType",
"tags": [],
"label": "color",
"description": [],
"signature": [
"\"text\" | \"warning\" | \"success\" | \"primary\" | \"accent\" | \"accentSecondary\" | \"danger\" | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlProps.css",
"type": "CompoundType",
"tags": [],
"label": "css",
"description": [],
"signature": [
"InterpolationPrimitive",
" | ",
"ArrayInterpolation",
"<",
"Theme",
"> | ",
"FunctionInterpolation",
"<",
"Theme",
">"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlProps.datatestsubj",
"type": "string",
"tags": [],
"label": "'data-test-subj'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlProps.disabled",
"type": "CompoundType",
"tags": [],
"label": "disabled",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlProps.iconType",
"type": "CompoundType",
"tags": [],
"label": "iconType",
"description": [],
"signature": [
"string | React.ComponentType<{}>"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlProps.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlProps.onClick",
"type": "Function",
"tags": [],
"label": "onClick",
"description": [],
"signature": [
"((props: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.RowControlRowProps",
"text": "RowControlRowProps"
},
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlProps.tooltipContent",
"type": "CompoundType",
"tags": [],
"label": "tooltipContent",
"description": [],
"signature": [
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlRowProps",
"type": "Interface",
"tags": [],
"label": "RowControlRowProps",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlRowProps.rowIndex",
"type": "number",
"tags": [],
"label": "rowIndex",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlRowProps.record",
"type": "Object",
"tags": [],
"label": "record",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ServiceFields",
"type": "Interface",
"tags": [],
"label": "ServiceFields",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ServiceFields.service.name",
"type": "string",
"tags": [],
"label": "'service.name'",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ServiceFields.service.environment",
"type": "string",
"tags": [],
"label": "'service.environment'",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ServiceFields.agent.name",
"type": "string",
"tags": [],
"label": "'agent.name'",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SpanTraceFields",
"type": "Interface",
"tags": [],
"label": "SpanTraceFields",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SpanTraceFields.span.id",
"type": "string",
"tags": [],
"label": "'span.id'",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SpanTraceFields.span.name",
"type": "string",
"tags": [],
"label": "'span.name'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SpanTraceFields.span.action",
"type": "string",
"tags": [],
"label": "'span.action'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SpanTraceFields.span.duration.us",
"type": "number",
"tags": [],
"label": "'span.duration.us'",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SpanTraceFields.span.type",
"type": "string",
"tags": [],
"label": "'span.type'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SpanTraceFields.span.subtype",
"type": "string",
"tags": [],
"label": "'span.subtype'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SpanTraceFields.span.destination.service.resource",
"type": "string",
"tags": [],
"label": "'span.destination.service.resource'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TraceDocumentOverview",
"type": "Interface",
"tags": [],
"label": "TraceDocumentOverview",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.TraceDocumentOverview",
"text": "TraceDocumentOverview"
},
" extends ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.ServiceFields",
"text": "ServiceFields"
},
",",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.TransactionTraceFields",
"text": "TransactionTraceFields"
},
",",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.SpanTraceFields",
"text": "SpanTraceFields"
},
",",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.UserAgentTraceFields",
"text": "UserAgentTraceFields"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TraceDocumentOverview.timestamp",
"type": "number",
"tags": [],
"label": "'@timestamp'",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TraceDocumentOverview.trace.id",
"type": "string",
"tags": [],
"label": "'trace.id'",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TraceDocumentOverview.parent.id",
"type": "string",
"tags": [],
"label": "'parent.id'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TraceDocumentOverview.http.response.status_code",
"type": "number",
"tags": [],
"label": "'http.response.status_code'",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TraceDocumentOverview.processor.event",
"type": "CompoundType",
"tags": [],
"label": "'processor.event'",
"description": [],
"signature": [
"\"transaction\" | \"span\" | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TracesContextService",
"type": "Interface",
"tags": [],
"label": "TracesContextService",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/traces/traces_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TracesContextService.getAllTracesIndexPattern",
"type": "Function",
"tags": [],
"label": "getAllTracesIndexPattern",
"description": [],
"signature": [
"() => string"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/traces/traces_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TracesContextService.isTracesIndexPattern",
"type": "Function",
"tags": [],
"label": "isTracesIndexPattern",
"description": [],
"signature": [
"(indexPattern: unknown) => boolean"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/traces/traces_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TracesContextService.isTracesIndexPattern.$1",
"type": "Unknown",
"tags": [],
"label": "indexPattern",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/traces/traces_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TracesContextService.containsTracesIndexPattern",
"type": "Function",
"tags": [],
"label": "containsTracesIndexPattern",
"description": [],
"signature": [
"(indexPattern: unknown) => boolean"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/traces/traces_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TracesContextService.containsTracesIndexPattern.$1",
"type": "Unknown",
"tags": [],
"label": "indexPattern",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/traces/traces_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TransactionTraceFields",
"type": "Interface",
"tags": [],
"label": "TransactionTraceFields",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TransactionTraceFields.transaction.id",
"type": "string",
"tags": [],
"label": "'transaction.id'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TransactionTraceFields.transaction.name",
"type": "string",
"tags": [],
"label": "'transaction.name'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TransactionTraceFields.transaction.duration.us",
"type": "number",
"tags": [],
"label": "'transaction.duration.us'",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.UserAgentTraceFields",
"type": "Interface",
"tags": [],
"label": "UserAgentTraceFields",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.UserAgentTraceFields.user_agent.name",
"type": "string",
"tags": [],
"label": "'user_agent.name'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.UserAgentTraceFields.user_agent.version",
"type": "string",
"tags": [],
"label": "'user_agent.version'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionId",
"type": "Enum",
"tags": [],
"label": "AppMenuActionId",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionType",
"type": "Enum",
"tags": [],
"label": "AppMenuActionType",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DiscoverFlyouts",
"type": "Enum",
"tags": [],
"label": "DiscoverFlyouts",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/dismiss_flyouts.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.IgnoredReason",
"type": "Enum",
"tags": [],
"label": "IgnoredReason",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_ignored_reason.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LogLevelCoalescedValue",
"type": "Enum",
"tags": [],
"label": "LogLevelCoalescedValue",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/utils/get_log_level_coalesed_value.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ACTIONS_COLUMN_WIDTH",
"type": "number",
"tags": [],
"label": "ACTIONS_COLUMN_WIDTH",
"description": [],
"signature": [
"80"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AGENT_NAME_FIELD",
"type": "string",
"tags": [],
"label": "AGENT_NAME_FIELD",
"description": [],
"signature": [
"\"agent.name\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionSubmenuCustom",
"type": "Type",
"tags": [],
"label": "AppMenuActionSubmenuCustom",
"description": [
"\nA menu action which opens a submenu with more custom actions"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionSubmenuBase",
"text": "AppMenuActionSubmenuBase"
},
"<",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionCustom",
"text": "AppMenuActionCustom"
},
">"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuActionSubmenuSecondary",
"type": "Type",
"tags": [],
"label": "AppMenuActionSubmenuSecondary",
"description": [
"\nA menu action which opens a submenu with more secondary actions"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionSubmenuBase",
"text": "AppMenuActionSubmenuBase"
},
"<",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionSecondary",
"text": "AppMenuActionSecondary"
},
">"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuControlProps",
"type": "Type",
"tags": [],
"label": "AppMenuControlProps",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuData",
"text": "TopNavMenuData"
},
", \"label\" | \"description\" | \"href\" | \"tooltip\" | \"isLoading\" | \"testId\" | \"disableButton\"> & { onClick: ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => Promise<void | React.ReactNode>) | ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => void | React.ReactNode) | undefined; }"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuControlWithIconProps",
"type": "Type",
"tags": [],
"label": "AppMenuControlWithIconProps",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuData",
"text": "TopNavMenuData"
},
", \"label\" | \"description\" | \"href\" | \"tooltip\" | \"isLoading\" | \"testId\" | \"disableButton\"> & { onClick: ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => Promise<void | React.ReactNode>) | ((params: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuControlOnClickParams",
"text": "AppMenuControlOnClickParams"
},
") => void | React.ReactNode) | undefined; } & { iconType: \"string\" | \"number\" | \"function\" | \"key\" | \"namespace\" | \"error\" | \"filter\" | \"search\" | \"link\" | \"at\" | \"nested\" | \"ip\" | \"push\" | \"list\" | \"cluster\" | \"eql\" | \"index\" | \"unlink\" | \"alert\" | \"color\" | \"grid\" | \"aggregate\" | \"code\" | \"warning\" | \"annotation\" | \"stats\" | \"mobile\" | \"article\" | \"menu\" | \"section\" | \"image\" | \"stop\" | \"download\" | \"document\" | \"email\" | \"copy\" | \"move\" | \"merge\" | \"partial\" | \"container\" | \"user\" | \"pause\" | \"share\" | \"home\" | \"spaces\" | \"package\" | \"endpoint\" | \"tag\" | \"beta\" | \"users\" | \"accessibility\" | \"addDataApp\" | \"advancedSettingsApp\" | \"agentApp\" | \"analyzeEvent\" | \"anomalyChart\" | \"anomalySwimLane\" | \"apmApp\" | \"apmTrace\" | \"appSearchApp\" | \"apps\" | \"arrowDown\" | \"arrowLeft\" | \"arrowRight\" | \"arrowUp\" | \"arrowStart\" | \"arrowEnd\" | \"asterisk\" | \"auditbeatApp\" | \"beaker\" | \"bell\" | \"bellSlash\" | \"bolt\" | \"boxesHorizontal\" | \"boxesVertical\" | \"branch\" | \"branchUser\" | \"broom\" | \"brush\" | \"bug\" | \"bullseye\" | \"calendar\" | \"canvasApp\" | \"casesApp\" | \"changePointDetection\" | \"check\" | \"checkCircle\" | \"checkInCircleFilled\" | \"cheer\" | \"classificationJob\" | \"clickLeft\" | \"clickRight\" | \"clock\" | \"clockCounter\" | \"cloudDrizzle\" | \"cloudStormy\" | \"cloudSunny\" | \"codeApp\" | \"compute\" | \"console\" | \"consoleApp\" | \"continuityAbove\" | \"continuityAboveBelow\" | \"continuityBelow\" | \"continuityWithin\" | \"contrast\" | \"contrastHigh\" | \"controlsHorizontal\" | \"controlsVertical\" | \"copyClipboard\" | \"createAdvancedJob\" | \"createGenericJob\" | \"createGeoJob\" | \"createMultiMetricJob\" | \"createPopulationJob\" | \"createSingleMetricJob\" | \"cross\" | \"crossClusterReplicationApp\" | \"crossInCircle\" | \"crosshairs\" | \"currency\" | \"cut\" | \"dashboardApp\" | \"dataVisualizer\" | \"database\" | \"desktop\" | \"devToolsApp\" | \"diff\" | \"discoverApp\" | \"discuss\" | \"documentEdit\" | \"documentation\" | \"documents\" | \"dot\" | \"dotInCircle\" | \"doubleArrowLeft\" | \"doubleArrowRight\" | \"editorAlignCenter\" | \"editorAlignLeft\" | \"editorAlignRight\" | \"editorBold\" | \"editorChecklist\" | \"editorCodeBlock\" | \"editorComment\" | \"editorDistributeHorizontal\" | \"editorDistributeVertical\" | \"editorHeading\" | \"editorItalic\" | \"editorItemAlignBottom\" | \"editorItemAlignCenter\" | \"editorItemAlignLeft\" | \"editorItemAlignMiddle\" | \"editorItemAlignRight\" | \"editorItemAlignTop\" | \"editorLink\" | \"editorOrderedList\" | \"editorPositionBottomLeft\" | \"editorPositionBottomRight\" | \"editorPositionTopLeft\" | \"editorPositionTopRight\" | \"editorRedo\" | \"editorStrike\" | \"editorTable\" | \"editorUnderline\" | \"editorUndo\" | \"editorUnorderedList\" | \"empty\" | \"emsApp\" | \"eraser\" | \"errorFilled\" | \"esqlVis\" | \"exit\" | \"expand\" | \"expandMini\" | \"exportAction\" | \"eye\" | \"eyeClosed\" | \"faceHappy\" | \"faceNeutral\" | \"faceSad\" | \"fieldStatistics\" | \"filebeatApp\" | \"filterExclude\" | \"filterIgnore\" | \"filterInclude\" | \"filterInCircle\" | \"flag\" | \"fleetApp\" | \"fold\" | \"folderCheck\" | \"folderClosed\" | \"folderExclamation\" | \"folderOpen\" | \"frameNext\" | \"framePrevious\" | \"fullScreen\" | \"fullScreenExit\" | \"gear\" | \"gisApp\" | \"glasses\" | \"globe\" | \"grab\" | \"grabHorizontal\" | \"grabOmnidirectional\" | \"gradient\" | \"graphApp\" | \"grokApp\" | \"heart\" | \"heartbeatApp\" | \"heatmap\" | \"help\" | \"iInCircle\" | \"importAction\" | \"indexClose\" | \"indexEdit\" | \"indexFlush\" | \"indexManagementApp\" | \"indexMapping\" | \"indexOpen\" | \"indexPatternApp\" | \"indexRollupApp\" | \"indexRuntime\" | \"indexSettings\" | \"indexTemporary\" | \"infinity\" | \"inputOutput\" | \"inspect\" | \"invert\" | \"keyboard\" | \"kqlField\" | \"kqlFunction\" | \"kqlOperand\" | \"kqlSelector\" | \"kqlValue\" | \"kubernetesNode\" | \"kubernetesPod\" | \"launch\" | \"layers\" | \"lensApp\" | \"lettering\" | \"lineDashed\" | \"lineDotted\" | \"lineSolid\" | \"listAdd\" | \"lock\" | \"lockOpen\" | \"logPatternAnalysis\" | \"logRateAnalysis\" | \"logoAWS\" | \"logoAWSMono\" | \"logoAerospike\" | \"logoApache\" | \"logoAppSearch\" | \"logoAzure\" | \"logoAzureMono\" | \"logoBeats\" | \"logoBusinessAnalytics\" | \"logoCeph\" | \"logoCloud\" | \"logoCloudEnterprise\" | \"logoCode\" | \"logoCodesandbox\" | \"logoCouchbase\" | \"logoDocker\" | \"logoDropwizard\" | \"logoElastic\" | \"logoElasticStack\" | \"logoElasticsearch\" | \"logoEnterpriseSearch\" | \"logoEtcd\" | \"logoGCP\" | \"logoGCPMono\" | \"logoGithub\" | \"logoGmail\" | \"logoGolang\" | \"logoGoogleG\" | \"logoHAproxy\" | \"logoIBM\" | \"logoIBMMono\" | \"logoKafka\" | \"logoKibana\" | \"logoKubernetes\" | \"logoLogging\" | \"logoLogstash\" | \"logoMaps\" | \"logoMemcached\" | \"logoMetrics\" | \"logoMongodb\" | \"logoMySQL\" | \"logoNginx\" | \"logoObservability\" | \"logoOsquery\" | \"logoPhp\" | \"logoPostgres\" | \"logoPrometheus\" | \"logoRabbitmq\" | \"logoRedis\" | \"logoSecurity\" | \"logoSiteSearch\" | \"logoSketch\" | \"logoSlack\" | \"logoUptime\" | \"logoVulnerabilityManagement\" | \"logoWebhook\" | \"logoWindows\" | \"logoWorkplaceSearch\" | \"logsApp\" | \"logstashFilter\" | \"logstashIf\" | \"logstashInput\" | \"logstashOutput\" | \"logstashQueue\" | \"machineLearningApp\" | \"magnet\" | \"magnifyWithExclamation\" | \"magnifyWithMinus\" | \"magnifyWithPlus\" | \"managementApp\" | \"mapMarker\" | \"memory\" | \"menuDown\" | \"menuLeft\" | \"menuRight\" | \"menuUp\" | \"metricbeatApp\" | \"metricsApp\" | \"minimize\" | \"minus\" | \"minusInCircle\" | \"minusInCircleFilled\" | \"minusInSquare\" | \"monitoringApp\" | \"moon\" | \"newChat\" | \"node\" | \"notebookApp\" | \"offline\" | \"online\" | \"outlierDetectionJob\" | \"packetbeatApp\" | \"pageSelect\" | \"pagesSelect\" | \"palette\" | \"paperClip\" | \"payment\" | \"pencil\" | \"percent\" | \"pin\" | \"pinFilled\" | \"pipeBreaks\" | \"pipelineApp\" | \"pipeNoBreaks\" | \"pivot\" | \"play\" | \"playFilled\" | \"plugs\" | \"plus\" | \"plusInCircle\" | \"plusInCircleFilled\" | \"plusInSquare\" | \"popout\" | \"questionInCircle\" | \"quote\" | \"recentlyViewedApp\" | \"refresh\" | \"regressionJob\" | \"reporter\" | \"reportingApp\" | \"returnKey\" | \"save\" | \"savedObjectsApp\" | \"scale\" | \"searchProfilerApp\" | \"securityAnalyticsApp\" | \"securityApp\" | \"securitySignal\" | \"securitySignalDetected\" | \"securitySignalResolved\" | \"sessionViewer\" | \"shard\" | \"singleMetricViewer\" | \"snowflake\" | \"sortAscending\" | \"sortDescending\" | \"sortDown\" | \"sortLeft\" | \"sortRight\" | \"sortUp\" | \"sortable\" | \"spacesApp\" | \"sparkles\" | \"sqlApp\" | \"starEmpty\" | \"starEmptySpace\" | \"starFilled\" | \"starFilledSpace\" | \"starMinusEmpty\" | \"starMinusFilled\" | \"starPlusEmpty\" | \"starPlusFilled\" | \"stopFilled\" | \"stopSlash\" | \"storage\" | \"submodule\" | \"sun\" | \"swatchInput\" | \"symlink\" | \"tableDensityCompact\" | \"tableDensityExpanded\" | \"tableDensityNormal\" | \"tableOfContents\" | \"tear\" | \"temperature\" | \"timeline\" | \"timelineWithArrow\" | \"timelionApp\" | \"timeRefresh\" | \"timeslider\" | \"training\" | \"transitionLeftIn\" | \"transitionLeftOut\" | \"transitionTopIn\" | \"transitionTopOut\" | \"trash\" | \"unfold\" | \"upgradeAssistantApp\" | \"uptimeApp\" | \"userAvatar\" | \"usersRolesApp\" | \"vector\" | \"videoPlayer\" | \"visArea\" | \"visAreaStacked\" | \"visBarHorizontal\" | \"visBarHorizontalStacked\" | \"visBarVertical\" | \"visBarVerticalStacked\" | \"visGauge\" | \"visGoal\" | \"visLine\" | \"visMapCoordinate\" | \"visMapRegion\" | \"visMetric\" | \"visPie\" | \"visTable\" | \"visTagCloud\" | \"visText\" | \"visTimelion\" | \"visVega\" | \"visVisualBuilder\" | \"visualizeApp\" | \"vulnerabilityManagementApp\" | \"warningFilled\" | \"watchesApp\" | \"web\" | \"wordWrap\" | \"wordWrapDisabled\" | \"workplaceSearchApp\" | \"wrench\" | \"tokenAlias\" | \"tokenAnnotation\" | \"tokenArray\" | \"tokenBinary\" | \"tokenBoolean\" | \"tokenClass\" | \"tokenCompletionSuggester\" | \"tokenConstant\" | \"tokenDate\" | \"tokenDimension\" | \"tokenElement\" | \"tokenEnum\" | \"tokenEnumMember\" | \"tokenEvent\" | \"tokenException\" | \"tokenField\" | \"tokenFile\" | \"tokenFlattened\" | \"tokenFunction\" | \"tokenGeo\" | \"tokenHistogram\" | \"tokenInterface\" | \"tokenIP\" | \"tokenJoin\" | \"tokenKey\" | \"tokenKeyword\" | \"tokenMethod\" | \"tokenMetricCounter\" | \"tokenMetricGauge\" | \"tokenModule\" | \"tokenNamespace\" | \"tokenNested\" | \"tokenNull\" | \"tokenNumber\" | \"tokenObject\" | \"tokenOperator\" | \"tokenPackage\" | \"tokenParameter\" | \"tokenPercolator\" | \"tokenProperty\" | \"tokenRange\" | \"tokenRankFeature\" | \"tokenRankFeatures\" | \"tokenRepo\" | \"tokenSearchType\" | \"tokenSemanticText\" | \"tokenShape\" | \"tokenString\" | \"tokenStruct\" | \"tokenSymbol\" | \"tokenTag\" | \"tokenText\" | \"tokenTokenCount\" | \"tokenVariable\" | \"tokenVectorDense\" | \"tokenDenseVector\" | \"tokenVectorSparse\"; }"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuItem",
"type": "Type",
"tags": [],
"label": "AppMenuItem",
"description": [
"\nA menu item can be primary, secondary or custom"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionPrimary",
"text": "AppMenuActionPrimary"
},
" | ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuItemSecondary",
"text": "AppMenuItemSecondary"
},
" | ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuItemCustom",
"text": "AppMenuItemCustom"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuItemCustom",
"type": "Type",
"tags": [],
"label": "AppMenuItemCustom",
"description": [
"\nA custom menu item can have only a label or a submenu"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionCustom",
"text": "AppMenuActionCustom"
},
" | ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionSubmenuCustom",
"text": "AppMenuActionSubmenuCustom"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuItemPrimary",
"type": "Type",
"tags": [],
"label": "AppMenuItemPrimary",
"description": [
"\nA primary menu item can only have an icon"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionPrimary",
"text": "AppMenuActionPrimary"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.AppMenuItemSecondary",
"type": "Type",
"tags": [],
"label": "AppMenuItemSecondary",
"description": [
"\nA secondary menu item can have only a label or a submenu"
],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionSecondary",
"text": "AppMenuActionSecondary"
},
" | ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.AppMenuActionSubmenuSecondary",
"text": "AppMenuActionSubmenuSecondary"
}
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/app_menu/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CLOUD_AVAILABILITY_ZONE_FIELD",
"type": "string",
"tags": [],
"label": "CLOUD_AVAILABILITY_ZONE_FIELD",
"description": [],
"signature": [
"\"cloud.availability_zone\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CLOUD_INSTANCE_ID_FIELD",
"type": "string",
"tags": [],
"label": "CLOUD_INSTANCE_ID_FIELD",
"description": [],
"signature": [
"\"cloud.instance.id\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CLOUD_PROJECT_ID_FIELD",
"type": "string",
"tags": [],
"label": "CLOUD_PROJECT_ID_FIELD",
"description": [],
"signature": [
"\"cloud.project.id\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CLOUD_PROVIDER_FIELD",
"type": "string",
"tags": [],
"label": "CLOUD_PROVIDER_FIELD",
"description": [],
"signature": [
"\"cloud.provider\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CLOUD_REGION_FIELD",
"type": "string",
"tags": [],
"label": "CLOUD_REGION_FIELD",
"description": [],
"signature": [
"\"cloud.region\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CONTAINER_ID_FIELD",
"type": "string",
"tags": [],
"label": "CONTAINER_ID_FIELD",
"description": [],
"signature": [
"\"container.id\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CONTAINER_NAME_FIELD",
"type": "string",
"tags": [],
"label": "CONTAINER_NAME_FIELD",
"description": [],
"signature": [
"\"container.name\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CONTENT_FIELD",
"type": "string",
"tags": [],
"label": "CONTENT_FIELD",
"description": [],
"signature": [
"\"content\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CONTEXT_DEFAULT_SIZE_SETTING",
"type": "string",
"tags": [],
"label": "CONTEXT_DEFAULT_SIZE_SETTING",
"description": [],
"signature": [
"\"context:defaultSize\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CONTEXT_STEP_SETTING",
"type": "string",
"tags": [],
"label": "CONTEXT_STEP_SETTING",
"description": [],
"signature": [
"\"context:step\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CONTEXT_TIE_BREAKER_FIELDS_SETTING",
"type": "string",
"tags": [],
"label": "CONTEXT_TIE_BREAKER_FIELDS_SETTING",
"description": [],
"signature": [
"\"context:tieBreakerFields\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DATA_GRID_COLUMN_WIDTH_MEDIUM",
"type": "number",
"tags": [],
"label": "DATA_GRID_COLUMN_WIDTH_MEDIUM",
"description": [],
"signature": [
"320"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DATA_GRID_COLUMN_WIDTH_SMALL",
"type": "number",
"tags": [],
"label": "DATA_GRID_COLUMN_WIDTH_SMALL",
"description": [],
"signature": [
"240"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DATASTREAM_DATASET_FIELD",
"type": "string",
"tags": [],
"label": "DATASTREAM_DATASET_FIELD",
"description": [],
"signature": [
"\"data_stream.dataset\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DATASTREAM_NAMESPACE_FIELD",
"type": "string",
"tags": [],
"label": "DATASTREAM_NAMESPACE_FIELD",
"description": [],
"signature": [
"\"data_stream.namespace\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DATASTREAM_TYPE_FIELD",
"type": "string",
"tags": [],
"label": "DATASTREAM_TYPE_FIELD",
"description": [],
"signature": [
"\"data_stream.type\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DataTableColumnsMeta",
"type": "Type",
"tags": [],
"label": "DataTableColumnsMeta",
"description": [
"\nCustom column types per column name"
],
"signature": [
"{ [x: string]: { type: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumnType",
"text": "DatatableColumnType"
},
"; esType?: string | undefined; }; }"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DEFAULT_ALLOWED_DATA_VIEWS",
"type": "Array",
"tags": [],
"label": "DEFAULT_ALLOWED_DATA_VIEWS",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DEFAULT_ALLOWED_LOGS_BASE_PATTERNS",
"type": "Array",
"tags": [],
"label": "DEFAULT_ALLOWED_LOGS_BASE_PATTERNS",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/logs_context_service.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DEFAULT_ALLOWED_LOGS_DATA_VIEWS",
"type": "Array",
"tags": [],
"label": "DEFAULT_ALLOWED_LOGS_DATA_VIEWS",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DEFAULT_COLUMNS",
"type": "Array",
"tags": [],
"label": "DEFAULT_COLUMNS",
"description": [],
"signature": [
"SmartFieldGridColumnOptions",
"[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DEFAULT_COLUMNS_SETTING",
"type": "string",
"tags": [],
"label": "DEFAULT_COLUMNS_SETTING",
"description": [],
"signature": [
"\"defaultColumns\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DEFAULT_ROWS_PER_PAGE",
"type": "number",
"tags": [],
"label": "DEFAULT_ROWS_PER_PAGE",
"description": [],
"signature": [
"100"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DOC_HIDE_TIME_COLUMN_SETTING",
"type": "string",
"tags": [],
"label": "DOC_HIDE_TIME_COLUMN_SETTING",
"description": [],
"signature": [
"\"doc_table:hideTimeColumn\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ERROR_EXCEPTION_STACKTRACE_ABS_PATH",
"type": "string",
"tags": [],
"label": "ERROR_EXCEPTION_STACKTRACE_ABS_PATH",
"description": [],
"signature": [
"\"error.exception.stacktrace.abs_path\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ERROR_LOG_STACKTRACE_ABS_PATH",
"type": "string",
"tags": [],
"label": "ERROR_LOG_STACKTRACE_ABS_PATH",
"description": [],
"signature": [
"\"error.log.stacktrace.abs_path\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ERROR_MESSAGE_FIELD",
"type": "string",
"tags": [],
"label": "ERROR_MESSAGE_FIELD",
"description": [],
"signature": [
"\"error.message\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ERROR_STACK_TRACE",
"type": "string",
"tags": [],
"label": "ERROR_STACK_TRACE",
"description": [],
"signature": [
"\"error.stack_trace\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.EVENT_ORIGINAL_FIELD",
"type": "string",
"tags": [],
"label": "EVENT_ORIGINAL_FIELD",
"description": [],
"signature": [
"\"event.original\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.EVENT_OUTCOME_FIELD",
"type": "string",
"tags": [],
"label": "EVENT_OUTCOME_FIELD",
"description": [],
"signature": [
"\"event.outcome\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.FIELDS_LIMIT_SETTING",
"type": "string",
"tags": [],
"label": "FIELDS_LIMIT_SETTING",
"description": [],
"signature": [
"\"fields:popularLimit\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.FILTER_OUT_EXACT_FIELDS_FOR_CONTENT",
"type": "Array",
"tags": [],
"label": "FILTER_OUT_EXACT_FIELDS_FOR_CONTENT",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.FILTER_OUT_FIELDS_PREFIXES_FOR_CONTENT",
"type": "Array",
"tags": [],
"label": "FILTER_OUT_FIELDS_PREFIXES_FOR_CONTENT",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.FormattedHit",
"type": "Type",
"tags": [],
"label": "FormattedHit",
"description": [
"\nPairs array for each field in the hit"
],
"signature": [
"FormattedHitPair[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.HIDE_ANNOUNCEMENTS",
"type": "string",
"tags": [],
"label": "HIDE_ANNOUNCEMENTS",
"description": [],
"signature": [
"\"hideAnnouncements\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.HOST_NAME_FIELD",
"type": "string",
"tags": [],
"label": "HOST_NAME_FIELD",
"description": [],
"signature": [
"\"host.name\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.HTTP_RESPONSE_STATUS_CODE_FIELD",
"type": "string",
"tags": [],
"label": "HTTP_RESPONSE_STATUS_CODE_FIELD",
"description": [],
"signature": [
"\"http.response.status_code\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.IGNORED_FIELD",
"type": "string",
"tags": [],
"label": "IGNORED_FIELD",
"description": [],
"signature": [
"\"_ignored\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.IGNORED_FIELD_VALUES_FIELD",
"type": "string",
"tags": [],
"label": "IGNORED_FIELD_VALUES_FIELD",
"description": [],
"signature": [
"\"ignored_field_values\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.INDEX_FIELD",
"type": "string",
"tags": [],
"label": "INDEX_FIELD",
"description": [],
"signature": [
"\"_index\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LOG_FILE_PATH_FIELD",
"type": "string",
"tags": [],
"label": "LOG_FILE_PATH_FIELD",
"description": [],
"signature": [
"\"log.file.path\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LOG_LEVEL_FIELD",
"type": "string",
"tags": [],
"label": "LOG_LEVEL_FIELD",
"description": [],
"signature": [
"\"log.level\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LOG_LEVEL_FIELDS",
"type": "Array",
"tags": [],
"label": "LOG_LEVEL_FIELDS",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.LOGS_EXPLORER_PROFILE_ID",
"type": "string",
"tags": [],
"label": "LOGS_EXPLORER_PROFILE_ID",
"description": [],
"signature": [
"\"logs-explorer\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.MAX_DOC_FIELDS_DISPLAYED",
"type": "string",
"tags": [],
"label": "MAX_DOC_FIELDS_DISPLAYED",
"description": [],
"signature": [
"\"discover:maxDocFieldsDisplayed\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.MESSAGE_FIELD",
"type": "string",
"tags": [],
"label": "MESSAGE_FIELD",
"description": [],
"signature": [
"\"message\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.MODIFY_COLUMNS_ON_SWITCH",
"type": "string",
"tags": [],
"label": "MODIFY_COLUMNS_ON_SWITCH",
"description": [],
"signature": [
"\"discover:modifyColumnsOnSwitch\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ORCHESTRATOR_CLUSTER_ID_FIELD",
"type": "string",
"tags": [],
"label": "ORCHESTRATOR_CLUSTER_ID_FIELD",
"description": [],
"signature": [
"\"orchestrator.cluster.id\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ORCHESTRATOR_CLUSTER_NAME_FIELD",
"type": "string",
"tags": [],
"label": "ORCHESTRATOR_CLUSTER_NAME_FIELD",
"description": [],
"signature": [
"\"orchestrator.cluster.name\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ORCHESTRATOR_NAMESPACE_FIELD",
"type": "string",
"tags": [],
"label": "ORCHESTRATOR_NAMESPACE_FIELD",
"description": [],
"signature": [
"\"orchestrator.namespace\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ORCHESTRATOR_RESOURCE_ID_FIELD",
"type": "string",
"tags": [],
"label": "ORCHESTRATOR_RESOURCE_ID_FIELD",
"description": [],
"signature": [
"\"orchestrator.resource.id\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.PARENT_ID_FIELD",
"type": "string",
"tags": [],
"label": "PARENT_ID_FIELD",
"description": [],
"signature": [
"\"parent.id\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.PROCESSOR_EVENT_FIELD",
"type": "string",
"tags": [],
"label": "PROCESSOR_EVENT_FIELD",
"description": [],
"signature": [
"\"processor.event\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RESOURCE_FIELD",
"type": "string",
"tags": [],
"label": "RESOURCE_FIELD",
"description": [],
"signature": [
"\"resource\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ROW_HEIGHT_OPTION",
"type": "string",
"tags": [],
"label": "ROW_HEIGHT_OPTION",
"description": [],
"signature": [
"\"discover:rowHeightOption\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlComponent",
"type": "Type",
"tags": [],
"label": "RowControlComponent",
"description": [],
"signature": [
"React.FunctionComponent<",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.RowControlProps",
"text": "RowControlProps"
},
">"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/components/custom_control_columns/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlComponent.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RowControlComponent.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SAMPLE_ROWS_PER_PAGE_SETTING",
"type": "string",
"tags": [],
"label": "SAMPLE_ROWS_PER_PAGE_SETTING",
"description": [],
"signature": [
"\"discover:sampleRowsPerPage\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SAMPLE_SIZE_SETTING",
"type": "string",
"tags": [],
"label": "SAMPLE_SIZE_SETTING",
"description": [],
"signature": [
"\"discover:sampleSize\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.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": "@kbn/discover-utils",
"id": "def-common.SEARCH_ON_PAGE_LOAD_SETTING",
"type": "string",
"tags": [],
"label": "SEARCH_ON_PAGE_LOAD_SETTING",
"description": [],
"signature": [
"\"discover:searchOnPageLoad\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SERVICE_ENVIRONMENT_FIELD",
"type": "string",
"tags": [],
"label": "SERVICE_ENVIRONMENT_FIELD",
"description": [],
"signature": [
"\"service.environment\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SERVICE_NAME_FIELD",
"type": "string",
"tags": [],
"label": "SERVICE_NAME_FIELD",
"description": [],
"signature": [
"\"service.name\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SERVICE_NAME_FIELDS",
"type": "Array",
"tags": [],
"label": "SERVICE_NAME_FIELDS",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ShouldShowFieldInTableHandler",
"type": "Type",
"tags": [],
"label": "ShouldShowFieldInTableHandler",
"description": [],
"signature": [
"(fieldName: string) => boolean"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_should_show_field_handler.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.ShouldShowFieldInTableHandler.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_should_show_field_handler.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SHOW_FIELD_STATISTICS",
"type": "string",
"tags": [],
"label": "SHOW_FIELD_STATISTICS",
"description": [],
"signature": [
"\"discover:showFieldStatistics\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SHOW_MULTIFIELDS",
"type": "string",
"tags": [],
"label": "SHOW_MULTIFIELDS",
"description": [],
"signature": [
"\"discover:showMultiFields\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SORT_DEFAULT_ORDER_SETTING",
"type": "string",
"tags": [],
"label": "SORT_DEFAULT_ORDER_SETTING",
"description": [],
"signature": [
"\"discover:sort:defaultOrder\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SPAN_ACTION_FIELD",
"type": "string",
"tags": [],
"label": "SPAN_ACTION_FIELD",
"description": [],
"signature": [
"\"span.action\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SPAN_DESTINATION_SERVICE_RESOURCE_FIELD",
"type": "string",
"tags": [],
"label": "SPAN_DESTINATION_SERVICE_RESOURCE_FIELD",
"description": [],
"signature": [
"\"span.destination.service.resource\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SPAN_DURATION_FIELD",
"type": "string",
"tags": [],
"label": "SPAN_DURATION_FIELD",
"description": [],
"signature": [
"\"span.duration.us\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SPAN_ID_FIELD",
"type": "string",
"tags": [],
"label": "SPAN_ID_FIELD",
"description": [],
"signature": [
"\"span.id\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SPAN_NAME_FIELD",
"type": "string",
"tags": [],
"label": "SPAN_NAME_FIELD",
"description": [],
"signature": [
"\"span.name\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SPAN_SUBTYPE_FIELD",
"type": "string",
"tags": [],
"label": "SPAN_SUBTYPE_FIELD",
"description": [],
"signature": [
"\"span.subtype\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SPAN_TYPE_FIELD",
"type": "string",
"tags": [],
"label": "SPAN_TYPE_FIELD",
"description": [],
"signature": [
"\"span.type\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TIMESTAMP_FIELD",
"type": "string",
"tags": [],
"label": "TIMESTAMP_FIELD",
"description": [],
"signature": [
"\"@timestamp\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TRACE_ID_FIELD",
"type": "string",
"tags": [],
"label": "TRACE_ID_FIELD",
"description": [],
"signature": [
"\"trace.id\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TRANSACTION_DURATION_FIELD",
"type": "string",
"tags": [],
"label": "TRANSACTION_DURATION_FIELD",
"description": [],
"signature": [
"\"transaction.duration.us\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TRANSACTION_ID_FIELD",
"type": "string",
"tags": [],
"label": "TRANSACTION_ID_FIELD",
"description": [],
"signature": [
"\"transaction.id\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TRANSACTION_NAME_FIELD",
"type": "string",
"tags": [],
"label": "TRANSACTION_NAME_FIELD",
"description": [],
"signature": [
"\"transaction.name\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.USER_AGENT_NAME_FIELD",
"type": "string",
"tags": [],
"label": "USER_AGENT_NAME_FIELD",
"description": [],
"signature": [
"\"user_agent.name\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.USER_AGENT_VERSION_FIELD",
"type": "string",
"tags": [],
"label": "USER_AGENT_VERSION_FIELD",
"description": [],
"signature": [
"\"user_agent.version\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CONTENT_FIELD_CONFIGURATION",
"type": "Object",
"tags": [],
"label": "CONTENT_FIELD_CONFIGURATION",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CONTENT_FIELD_CONFIGURATION.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"smart-field\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CONTENT_FIELD_CONFIGURATION.smartField",
"type": "string",
"tags": [],
"label": "smartField",
"description": [],
"signature": [
"\"content\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.CONTENT_FIELD_CONFIGURATION.fallbackFields",
"type": "Array",
"tags": [],
"label": "fallbackFields",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DEGRADED_DOCS_FIELDS",
"type": "Object",
"tags": [],
"label": "DEGRADED_DOCS_FIELDS",
"description": [],
"signature": [
"readonly [\"_ignored\", \"ignored_field_values\"]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/field_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.DURATION_FIELDS",
"type": "Object",
"tags": [],
"label": "DURATION_FIELDS",
"description": [],
"signature": [
"readonly string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RESOURCE_FIELD_CONFIGURATION",
"type": "Object",
"tags": [],
"label": "RESOURCE_FIELD_CONFIGURATION",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RESOURCE_FIELD_CONFIGURATION.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"smart-field\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RESOURCE_FIELD_CONFIGURATION.smartField",
"type": "string",
"tags": [],
"label": "smartField",
"description": [],
"signature": [
"\"resource\""
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RESOURCE_FIELD_CONFIGURATION.fallbackFields",
"type": "Array",
"tags": [],
"label": "fallbackFields",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RESOURCE_FIELD_CONFIGURATION.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.RESOURCE_FIELDS",
"type": "Object",
"tags": [],
"label": "RESOURCE_FIELDS",
"description": [],
"signature": [
"readonly [\"service.name\", \"container.name\", \"host.name\", \"orchestrator.resource.id\", \"orchestrator.cluster.name\", \"orchestrator.cluster.id\", \"container.id\", \"agent.name\"]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SMART_FALLBACK_FIELDS",
"type": "Object",
"tags": [],
"label": "SMART_FALLBACK_FIELDS",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SMART_FALLBACK_FIELDS.CONTENT_FIELD",
"type": "Object",
"tags": [],
"label": "[CONTENT_FIELD]",
"description": [],
"signature": [
"SmartFieldGridColumnOptions"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.SMART_FALLBACK_FIELDS.RESOURCE_FIELD",
"type": "Object",
"tags": [],
"label": "[RESOURCE_FIELD]",
"description": [],
"signature": [
"SmartFieldGridColumnOptions"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/discover-utils",
"id": "def-common.TRACE_FIELDS",
"type": "Object",
"tags": [],
"label": "TRACE_FIELDS",
"description": [],
"signature": [
"readonly [\"service.name\", \"event.outcome\", \"transaction.name\", \"transaction.duration.us\", \"span.name\", \"span.duration.us\", \"agent.name\"]"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/data_types/logs/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}