[api-docs] 2023-08-23 Daily api_docs build (#164524)

Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/438
This commit is contained in:
Kibana Machine 2023-08-23 00:51:37 -04:00 committed by GitHub
parent 2b47e4b346
commit b7c9175320
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
624 changed files with 1937 additions and 3836 deletions

View file

@ -5545,13 +5545,10 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.AlertingConnectorFeature.name", "id": "def-common.AlertingConnectorFeature.name",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "name", "label": "name",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -5559,13 +5556,10 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.AlertingConnectorFeature.compatibility", "id": "def-common.AlertingConnectorFeature.compatibility",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "compatibility", "label": "compatibility",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -5598,13 +5592,10 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.CasesConnectorFeature.name", "id": "def-common.CasesConnectorFeature.name",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "name", "label": "name",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -5612,13 +5603,10 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.CasesConnectorFeature.compatibility", "id": "def-common.CasesConnectorFeature.compatibility",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "compatibility", "label": "compatibility",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -5724,13 +5712,10 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.GeneralFeature.name", "id": "def-common.GeneralFeature.name",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "name", "label": "name",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -5738,13 +5723,10 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.GeneralFeature.compatibility", "id": "def-common.GeneralFeature.compatibility",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "compatibility", "label": "compatibility",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -5792,13 +5774,10 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.SecuritySolutionFeature.name", "id": "def-common.SecuritySolutionFeature.name",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "name", "label": "name",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -5806,13 +5785,10 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.SecuritySolutionFeature.compatibility", "id": "def-common.SecuritySolutionFeature.compatibility",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "compatibility", "label": "compatibility",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -5845,13 +5821,10 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.UptimeConnectorFeature.name", "id": "def-common.UptimeConnectorFeature.name",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "name", "label": "name",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -5859,13 +5832,10 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.UptimeConnectorFeature.compatibility", "id": "def-common.UptimeConnectorFeature.compatibility",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "compatibility", "label": "compatibility",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
title: "actions" title: "actions"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the actions plugin description: API docs for the actions plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
--- ---
import actionsObj from './actions.devdocs.json'; import actionsObj from './actions.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 275 | 10 | 269 | 27 | | 275 | 0 | 269 | 27 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings
title: "advancedSettings" title: "advancedSettings"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the advancedSettings plugin description: API docs for the advancedSettings plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
--- ---
import advancedSettingsObj from './advanced_settings.devdocs.json'; import advancedSettingsObj from './advanced_settings.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops
title: "aiops" title: "aiops"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the aiops plugin description: API docs for the aiops plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
--- ---
import aiopsObj from './aiops.devdocs.json'; import aiopsObj from './aiops.devdocs.json';

View file

@ -4692,7 +4692,7 @@
"MuteOptions", "MuteOptions",
") => Promise<void>; unmuteInstance: (options: ", ") => Promise<void>; unmuteInstance: (options: ",
"MuteOptions", "MuteOptions",
") => Promise<void>; runSoon: (options: { id: string; }) => Promise<any>; listRuleTypes: () => Promise<Set<", ") => Promise<void>; runSoon: (options: { id: string; }) => Promise<string | undefined>; listRuleTypes: () => Promise<Set<",
"RegistryAlertTypeWithAuth", "RegistryAlertTypeWithAuth",
">>; getSpaceId: () => string | undefined; getAuthorization: () => ", ">>; getSpaceId: () => string | undefined; getAuthorization: () => ",
{ {

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
title: "alerting" title: "alerting"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the alerting plugin description: API docs for the alerting plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
--- ---
import alertingObj from './alerting.devdocs.json'; import alertingObj from './alerting.devdocs.json';

File diff suppressed because it is too large Load diff

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
title: "apm" title: "apm"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the apm plugin description: API docs for the apm plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
--- ---
import apmObj from './apm.devdocs.json'; import apmObj from './apm.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) for ques
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 48 | 0 | 48 | 120 | | 29 | 0 | 29 | 118 |
## Client ## Client
@ -42,9 +42,6 @@ Contact [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) for ques
### Classes ### Classes
<DocDefinitionList data={apmObj.server.classes}/> <DocDefinitionList data={apmObj.server.classes}/>
### Interfaces
<DocDefinitionList data={apmObj.server.interfaces}/>
### Consts, variables and types ### Consts, variables and types
<DocDefinitionList data={apmObj.server.misc}/> <DocDefinitionList data={apmObj.server.misc}/>

View file

@ -0,0 +1,178 @@
{
"id": "apmDataAccess",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "apmDataAccess",
"id": "def-server.APMDataAccessConfig",
"type": "Type",
"tags": [],
"label": "APMDataAccessConfig",
"description": [],
"signature": [
"{ readonly indices: Readonly<{} & { error: string; metric: string; transaction: string; span: string; onboarding: string; }>; }"
],
"path": "x-pack/plugins/apm_data_access/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "apmDataAccess",
"id": "def-server.APMIndices",
"type": "Type",
"tags": [],
"label": "APMIndices",
"description": [],
"signature": [
"{ readonly error: string; readonly metric: string; readonly transaction: string; readonly span: string; readonly onboarding: string; }"
],
"path": "x-pack/plugins/apm_data_access/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessPluginSetup",
"type": "Interface",
"tags": [],
"label": "ApmDataAccessPluginSetup",
"description": [],
"path": "x-pack/plugins/apm_data_access/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessPluginSetup.apmIndicesFromConfigFile",
"type": "Object",
"tags": [],
"label": "apmIndicesFromConfigFile",
"description": [],
"signature": [
"{ readonly error: string; readonly metric: string; readonly transaction: string; readonly span: string; readonly onboarding: string; }"
],
"path": "x-pack/plugins/apm_data_access/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessPluginSetup.getApmIndices",
"type": "Function",
"tags": [],
"label": "getApmIndices",
"description": [],
"signature": [
"(soClient: ",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
},
") => Promise<Readonly<{} & { error: string; metric: string; transaction: string; span: string; onboarding: string; }>>"
],
"path": "x-pack/plugins/apm_data_access/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessPluginSetup.getApmIndices.$1",
"type": "Object",
"tags": [],
"label": "soClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
}
],
"path": "x-pack/plugins/apm_data_access/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessPluginStart",
"type": "Interface",
"tags": [],
"label": "ApmDataAccessPluginStart",
"description": [],
"path": "x-pack/plugins/apm_data_access/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "apmDataAccess",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"apmDataAccess\""
],
"path": "x-pack/plugins/apm_data_access/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "apmDataAccess",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"apmDataAccess\""
],
"path": "x-pack/plugins/apm_data_access/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}

View file

@ -0,0 +1,41 @@
---
####
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
#### Reach out in #docs-engineering for more info.
####
id: kibApmDataAccessPluginApi
slug: /kibana-dev-docs/api/apmDataAccess
title: "apmDataAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apmDataAccess plugin
date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
---
import apmDataAccessObj from './apm_data_access.devdocs.json';
Contact [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 9 | 0 | 9 | 0 |
## Server
### Setup
<DocDefinitionList data={[apmDataAccessObj.server.setup]}/>
### Start
<DocDefinitionList data={[apmDataAccessObj.server.start]}/>
### Consts, variables and types
<DocDefinitionList data={apmDataAccessObj.server.misc}/>
## Common
### Consts, variables and types
<DocDefinitionList data={apmDataAccessObj.common.misc}/>

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetManager
title: "assetManager" title: "assetManager"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the assetManager plugin description: API docs for the assetManager plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager']
--- ---
import assetManagerObj from './asset_manager.devdocs.json'; import assetManagerObj from './asset_manager.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners
title: "banners" title: "banners"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the banners plugin description: API docs for the banners plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
--- ---
import bannersObj from './banners.devdocs.json'; import bannersObj from './banners.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch
title: "bfetch" title: "bfetch"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the bfetch plugin description: API docs for the bfetch plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
--- ---
import bfetchObj from './bfetch.devdocs.json'; import bfetchObj from './bfetch.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas
title: "canvas" title: "canvas"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the canvas plugin description: API docs for the canvas plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
--- ---
import canvasObj from './canvas.devdocs.json'; import canvasObj from './canvas.devdocs.json';

View file

@ -70,7 +70,7 @@
"section": "def-public.ICasesDeepLinkId", "section": "def-public.ICasesDeepLinkId",
"text": "ICasesDeepLinkId" "text": "ICasesDeepLinkId"
}, },
", Partial<T>>> | undefined; }) => { id: \"cases\"; path: string; deepLinks: ({ id: \"cases_create\"; path: string; title: any; keywords?: T[\"keywords\"] | undefined; navLinkStatus?: T[\"navLinkStatus\"] | undefined; searchable?: T[\"searchable\"] | undefined; category?: T[\"category\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; deepLinks?: T[\"deepLinks\"] | undefined; } | { id: \"cases_configure\"; path: string; title: any; keywords?: T[\"keywords\"] | undefined; navLinkStatus?: T[\"navLinkStatus\"] | undefined; searchable?: T[\"searchable\"] | undefined; category?: T[\"category\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; deepLinks?: T[\"deepLinks\"] | undefined; })[]; title: any; keywords?: T[\"keywords\"] | undefined; navLinkStatus?: T[\"navLinkStatus\"] | undefined; searchable?: T[\"searchable\"] | undefined; category?: T[\"category\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; }" ", Partial<T>>> | undefined; }) => { id: \"cases\"; path: string; deepLinks: ({ id: \"cases_create\"; path: string; title: string | T[\"title\"]; keywords?: T[\"keywords\"] | undefined; navLinkStatus?: T[\"navLinkStatus\"] | undefined; searchable?: T[\"searchable\"] | undefined; category?: T[\"category\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; deepLinks?: T[\"deepLinks\"] | undefined; } | { id: \"cases_configure\"; path: string; title: string | T[\"title\"]; keywords?: T[\"keywords\"] | undefined; navLinkStatus?: T[\"navLinkStatus\"] | undefined; searchable?: T[\"searchable\"] | undefined; category?: T[\"category\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; deepLinks?: T[\"deepLinks\"] | undefined; })[]; title: string | T[\"title\"]; keywords?: T[\"keywords\"] | undefined; navLinkStatus?: T[\"navLinkStatus\"] | undefined; searchable?: T[\"searchable\"] | undefined; category?: T[\"category\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; }"
], ],
"path": "x-pack/plugins/cases/public/common/navigation/deep_links.ts", "path": "x-pack/plugins/cases/public/common/navigation/deep_links.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
title: "cases" title: "cases"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cases plugin description: API docs for the cases plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
--- ---
import casesObj from './cases.devdocs.json'; import casesObj from './cases.devdocs.json';

View file

@ -1576,13 +1576,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.defaultCountLabel", "id": "def-public.defaultCountLabel",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "defaultCountLabel", "label": "defaultCountLabel",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/components/collections.ts", "path": "src/plugins/charts/common/static/components/collections.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false, "trackAdoption": false,
@ -1868,13 +1865,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.vislibColorMaps.ColorSchemas.Blues.label", "id": "def-public.vislibColorMaps.ColorSchemas.Blues.label",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1930,13 +1924,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.vislibColorMaps.ColorSchemas.Greens.label", "id": "def-public.vislibColorMaps.ColorSchemas.Greens.label",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1992,13 +1983,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.vislibColorMaps.ColorSchemas.Greys.label", "id": "def-public.vislibColorMaps.ColorSchemas.Greys.label",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2054,13 +2042,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.vislibColorMaps.ColorSchemas.Reds.label", "id": "def-public.vislibColorMaps.ColorSchemas.Reds.label",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2116,13 +2101,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed.label", "id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed.label",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2178,13 +2160,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed.label", "id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed.label",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3374,7 +3353,7 @@
"label": "AllowedSettingsOverrides", "label": "AllowedSettingsOverrides",
"description": [], "description": [],
"signature": [ "signature": [
"{ settings?: { debug?: boolean | undefined; theme?: ", "{ settings?: { theme?: ",
"MakeOverridesSerializable", "MakeOverridesSerializable",
"<", "<",
"RecursivePartial", "RecursivePartial",
@ -3390,7 +3369,7 @@
"LegendPositionConfig", "LegendPositionConfig",
" | undefined; rotation?: ", " | undefined; rotation?: ",
"Rotation", "Rotation",
" | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ", " | undefined; debug?: boolean | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ",
"Rendering", "Rendering",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ", " | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable", "MakeOverridesSerializable",
@ -3470,13 +3449,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.defaultCountLabel", "id": "def-common.defaultCountLabel",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "defaultCountLabel", "label": "defaultCountLabel",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/components/collections.ts", "path": "src/plugins/charts/common/static/components/collections.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false, "trackAdoption": false,
@ -3831,13 +3807,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.vislibColorMaps.ColorSchemas.Blues.label", "id": "def-common.vislibColorMaps.ColorSchemas.Blues.label",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3893,13 +3866,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.vislibColorMaps.ColorSchemas.Greens.label", "id": "def-common.vislibColorMaps.ColorSchemas.Greens.label",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3955,13 +3925,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.vislibColorMaps.ColorSchemas.Greys.label", "id": "def-common.vislibColorMaps.ColorSchemas.Greys.label",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -4017,13 +3984,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.vislibColorMaps.ColorSchemas.Reds.label", "id": "def-common.vislibColorMaps.ColorSchemas.Reds.label",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -4079,13 +4043,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.vislibColorMaps.ColorSchemas.YellowToRed.label", "id": "def-common.vislibColorMaps.ColorSchemas.YellowToRed.label",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -4141,13 +4102,10 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.vislibColorMaps.ColorSchemas.GreenToRed.label", "id": "def-common.vislibColorMaps.ColorSchemas.GreenToRed.label",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts
title: "charts" title: "charts"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the charts plugin description: API docs for the charts plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
--- ---
import chartsObj from './charts.devdocs.json'; import chartsObj from './charts.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 268 | 16 | 253 | 10 | | 268 | 2 | 253 | 10 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud
title: "cloud" title: "cloud"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloud plugin description: API docs for the cloud plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
--- ---
import cloudObj from './cloud.devdocs.json'; import cloudObj from './cloud.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChat
title: "cloudChat" title: "cloudChat"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudChat plugin description: API docs for the cloudChat plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat']
--- ---
import cloudChatObj from './cloud_chat.devdocs.json'; import cloudChatObj from './cloud_chat.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChatProvider
title: "cloudChatProvider" title: "cloudChatProvider"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudChatProvider plugin description: API docs for the cloudChatProvider plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChatProvider'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChatProvider']
--- ---
import cloudChatProviderObj from './cloud_chat_provider.devdocs.json'; import cloudChatProviderObj from './cloud_chat_provider.devdocs.json';

View file

@ -144,13 +144,10 @@
{ {
"parentPluginId": "cloudDataMigration", "parentPluginId": "cloudDataMigration",
"id": "def-common.PLUGIN_NAME", "id": "def-common.PLUGIN_NAME",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "PLUGIN_NAME", "label": "PLUGIN_NAME",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/cloud_integrations/cloud_data_migration/common/index.ts", "path": "x-pack/plugins/cloud_integrations/cloud_data_migration/common/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false, "trackAdoption": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration
title: "cloudDataMigration" title: "cloudDataMigration"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDataMigration plugin description: API docs for the cloudDataMigration plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
--- ---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json'; import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/platform-onboarding](https://github.com/orgs/elastic/teams/pla
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 8 | 1 | 8 | 1 | | 8 | 0 | 8 | 1 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend
title: "cloudDefend" title: "cloudDefend"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDefend plugin description: API docs for the cloudDefend plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
--- ---
import cloudDefendObj from './cloud_defend.devdocs.json'; import cloudDefendObj from './cloud_defend.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments
title: "cloudExperiments" title: "cloudExperiments"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudExperiments plugin description: API docs for the cloudExperiments plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
--- ---
import cloudExperimentsObj from './cloud_experiments.devdocs.json'; import cloudExperimentsObj from './cloud_experiments.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
title: "cloudSecurityPosture" title: "cloudSecurityPosture"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudSecurityPosture plugin description: API docs for the cloudSecurityPosture plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
--- ---
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json'; import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console
title: "console" title: "console"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the console plugin description: API docs for the console plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
--- ---
import consoleObj from './console.devdocs.json'; import consoleObj from './console.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement
title: "contentManagement" title: "contentManagement"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the contentManagement plugin description: API docs for the contentManagement plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
--- ---
import contentManagementObj from './content_management.devdocs.json'; import contentManagementObj from './content_management.devdocs.json';

View file

@ -1551,7 +1551,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"() => any" "() => string"
], ],
"path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false, "deprecated": false,
@ -2669,7 +2669,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"() => any" "() => string"
], ],
"path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx", "path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx",
"deprecated": false, "deprecated": false,
@ -2701,7 +2701,7 @@
"label": "getDescription", "label": "getDescription",
"description": [], "description": [],
"signature": [ "signature": [
"() => any" "() => string"
], ],
"path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx", "path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx",
"deprecated": false, "deprecated": false,
@ -3381,7 +3381,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"() => any" "() => string"
], ],
"path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx", "path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx",
"deprecated": false, "deprecated": false,
@ -3397,7 +3397,7 @@
"label": "getDescription", "label": "getDescription",
"description": [], "description": [],
"signature": [ "signature": [
"() => any" "() => string"
], ],
"path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx", "path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx",
"deprecated": false, "deprecated": false,
@ -6862,7 +6862,7 @@
"label": "newState", "label": "newState",
"description": [], "description": [],
"signature": [ "signature": [
"{ viewMode?: ", "{ version?: string | undefined; viewMode?: ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "common", "scope": "common",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/controls
title: "controls" title: "controls"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the controls plugin description: API docs for the controls plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
--- ---
import controlsObj from './controls.devdocs.json'; import controlsObj from './controls.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations
title: "customIntegrations" title: "customIntegrations"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the customIntegrations plugin description: API docs for the customIntegrations plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
--- ---
import customIntegrationsObj from './custom_integrations.devdocs.json'; import customIntegrationsObj from './custom_integrations.devdocs.json';

View file

@ -728,7 +728,7 @@
"section": "def-common.DashboardPanelMap", "section": "def-common.DashboardPanelMap",
"text": "DashboardPanelMap" "text": "DashboardPanelMap"
}, },
", versionOverride?: string | undefined) => ", ", removeLegacyVersion?: boolean | undefined) => ",
"SavedDashboardPanel", "SavedDashboardPanel",
"[]" "[]"
], ],
@ -760,12 +760,12 @@
{ {
"parentPluginId": "dashboard", "parentPluginId": "dashboard",
"id": "def-common.convertPanelMapToSavedPanels.$2", "id": "def-common.convertPanelMapToSavedPanels.$2",
"type": "string", "type": "CompoundType",
"tags": [], "tags": [],
"label": "versionOverride", "label": "removeLegacyVersion",
"description": [], "description": [],
"signature": [ "signature": [
"string | undefined" "boolean | undefined"
], ],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false, "deprecated": false,
@ -800,7 +800,7 @@
"section": "def-common.SavedObjectEmbeddableInput", "section": "def-common.SavedObjectEmbeddableInput",
"text": "SavedObjectEmbeddableInput" "text": "SavedObjectEmbeddableInput"
}, },
">, version: string | undefined) => ", ">, removeLegacyVersion: boolean | undefined) => ",
"SavedDashboardPanel" "SavedDashboardPanel"
], ],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
@ -840,12 +840,12 @@
{ {
"parentPluginId": "dashboard", "parentPluginId": "dashboard",
"id": "def-common.convertPanelStateToSavedDashboardPanel.$2", "id": "def-common.convertPanelStateToSavedDashboardPanel.$2",
"type": "string", "type": "CompoundType",
"tags": [], "tags": [],
"label": "version", "label": "removeLegacyVersion",
"description": [], "description": [],
"signature": [ "signature": [
"string | undefined" "boolean | undefined"
], ],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false, "deprecated": false,
@ -1761,6 +1761,22 @@
"path": "src/plugins/dashboard/common/dashboard_container/types.ts", "path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelState.version",
"type": "string",
"tags": [],
"label": "version",
"description": [
"\nThis version key was used to store Kibana version information from versions 7.3.0 -> 8.11.0.\nAs of version 8.11.0, the versioning information is now per-embeddable-type and is stored on the\nembeddable's input. This key is needed for BWC, but its value will be removed on Dashboard save."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
} }
], ],
"initialIsOpen": false "initialIsOpen": false
@ -1830,7 +1846,7 @@
"\nFor BWC reasons, dashboard state is stored with panels as an array instead of a map" "\nFor BWC reasons, dashboard state is stored with panels as an array instead of a map"
], ],
"signature": [ "signature": [
"{ id?: string | undefined; tags?: string[] | undefined; description?: string | undefined; title?: string | undefined; query?: ", "{ id?: string | undefined; tags?: string[] | undefined; description?: string | undefined; title?: string | undefined; version?: string | undefined; query?: ",
{ {
"pluginId": "@kbn/es-query", "pluginId": "@kbn/es-query",
"scope": "common", "scope": "common",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard
title: "dashboard" title: "dashboard"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboard plugin description: API docs for the dashboard plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
--- ---
import dashboardObj from './dashboard.devdocs.json'; import dashboardObj from './dashboard.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 100 | 0 | 98 | 9 | | 101 | 0 | 98 | 9 |
## Client ## Client

View file

@ -212,7 +212,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"() => any" "() => string"
], ],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false, "deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced
title: "dashboardEnhanced" title: "dashboardEnhanced"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboardEnhanced plugin description: API docs for the dashboardEnhanced plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
--- ---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json'; import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';

View file

@ -11089,13 +11089,10 @@
{ {
"parentPluginId": "data", "parentPluginId": "data",
"id": "def-public.AggGroupLabels.AggGroupNames.Buckets", "id": "def-public.AggGroupLabels.AggGroupNames.Buckets",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "[AggGroupNames.Buckets]", "label": "[AggGroupNames.Buckets]",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/data/common/search/aggs/agg_groups.ts", "path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -11103,13 +11100,10 @@
{ {
"parentPluginId": "data", "parentPluginId": "data",
"id": "def-public.AggGroupLabels.AggGroupNames.Metrics", "id": "def-public.AggGroupLabels.AggGroupNames.Metrics",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "[AggGroupNames.Metrics]", "label": "[AggGroupNames.Metrics]",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/data/common/search/aggs/agg_groups.ts", "path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -11117,13 +11111,10 @@
{ {
"parentPluginId": "data", "parentPluginId": "data",
"id": "def-public.AggGroupLabels.AggGroupNames.None", "id": "def-public.AggGroupLabels.AggGroupNames.None",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "[AggGroupNames.None]", "label": "[AggGroupNames.None]",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/data/common/search/aggs/agg_groups.ts", "path": "src/plugins/data/common/search/aggs/agg_groups.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -11735,7 +11726,7 @@
"label": "intervalOptions", "label": "intervalOptions",
"description": [], "description": [],
"signature": [ "signature": [
"({ display: any; val: string; enabled(agg: ", "({ display: string; val: string; enabled(agg: ",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -11743,7 +11734,7 @@
"section": "def-common.IBucketAggConfig", "section": "def-common.IBucketAggConfig",
"text": "IBucketAggConfig" "text": "IBucketAggConfig"
}, },
"): boolean; } | { display: any; val: string; })[]" "): boolean; } | { display: string; val: string; })[]"
], ],
"path": "src/plugins/data/public/index.ts", "path": "src/plugins/data/public/index.ts",
"deprecated": false, "deprecated": false,
@ -12052,13 +12043,10 @@
{ {
"parentPluginId": "data", "parentPluginId": "data",
"id": "def-public.search.aggs.parentPipelineType", "id": "def-public.search.aggs.parentPipelineType",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "parentPipelineType", "label": "parentPipelineType",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/data/public/index.ts", "path": "src/plugins/data/public/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -12161,13 +12149,10 @@
{ {
"parentPluginId": "data", "parentPluginId": "data",
"id": "def-public.search.aggs.siblingPipelineType", "id": "def-public.search.aggs.siblingPipelineType",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "siblingPipelineType", "label": "siblingPipelineType",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/data/public/index.ts", "path": "src/plugins/data/public/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -12233,7 +12218,7 @@
"label": "boundsDescendingRaw", "label": "boundsDescendingRaw",
"description": [], "description": [],
"signature": [ "signature": [
"({ bound: number; interval: moment.Duration; boundLabel: any; intervalLabel: any; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: any; intervalLabel: any; })[]" "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]"
], ],
"path": "src/plugins/data/public/index.ts", "path": "src/plugins/data/public/index.ts",
"deprecated": false, "deprecated": false,
@ -15826,6 +15811,17 @@
"returnComment": [], "returnComment": [],
"children": [] "children": []
}, },
{
"parentPluginId": "data",
"id": "def-server.DataViewsService.scriptedFieldsEnabled",
"type": "boolean",
"tags": [],
"label": "scriptedFieldsEnabled",
"description": [],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false
},
{ {
"parentPluginId": "data", "parentPluginId": "data",
"id": "def-server.DataViewsService.Unnamed", "id": "def-server.DataViewsService.Unnamed",
@ -19155,6 +19151,24 @@
"trackAdoption": false "trackAdoption": false
} }
] ]
},
{
"parentPluginId": "data",
"id": "def-server.DataViewsServerPluginStart.getScriptedFieldsEnabled",
"type": "Function",
"tags": [],
"label": "getScriptedFieldsEnabled",
"description": [
"\n"
],
"signature": [
"() => boolean"
],
"path": "src/plugins/data_views/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
} }
], ],
"initialIsOpen": false "initialIsOpen": false
@ -24433,6 +24447,17 @@
"returnComment": [], "returnComment": [],
"children": [] "children": []
}, },
{
"parentPluginId": "data",
"id": "def-common.DataViewsService.scriptedFieldsEnabled",
"type": "boolean",
"tags": [],
"label": "scriptedFieldsEnabled",
"description": [],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false
},
{ {
"parentPluginId": "data", "parentPluginId": "data",
"id": "def-common.DataViewsService.Unnamed", "id": "def-common.DataViewsService.Unnamed",
@ -28890,6 +28915,21 @@
"trackAdoption": false, "trackAdoption": false,
"initialIsOpen": false "initialIsOpen": false
}, },
{
"parentPluginId": "data",
"id": "def-common.SAVED_QUERY_BASE_URL",
"type": "string",
"tags": [],
"label": "SAVED_QUERY_BASE_URL",
"description": [],
"signature": [
"\"/internal/saved_query\""
],
"path": "src/plugins/data/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{ {
"parentPluginId": "data", "parentPluginId": "data",
"id": "def-common.SCRIPT_LANGUAGES_ROUTE_LATEST_VERSION", "id": "def-common.SCRIPT_LANGUAGES_ROUTE_LATEST_VERSION",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data
title: "data" title: "data"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the data plugin description: API docs for the data plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
--- ---
import dataObj from './data.devdocs.json'; import dataObj from './data.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3301 | 119 | 2575 | 27 | | 3306 | 33 | 2579 | 27 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query
title: "data.query" title: "data.query"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the data.query plugin description: API docs for the data.query plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
--- ---
import dataQueryObj from './data_query.devdocs.json'; import dataQueryObj from './data_query.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3301 | 119 | 2575 | 27 | | 3306 | 33 | 2579 | 27 |
## Client ## Client

File diff suppressed because it is too large Load diff

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search
title: "data.search" title: "data.search"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the data.search plugin description: API docs for the data.search plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
--- ---
import dataSearchObj from './data_search.devdocs.json'; import dataSearchObj from './data_search.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3301 | 119 | 2575 | 27 | | 3306 | 33 | 2579 | 27 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewEditor
title: "dataViewEditor" title: "dataViewEditor"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewEditor plugin description: API docs for the dataViewEditor plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
--- ---
import dataViewEditorObj from './data_view_editor.devdocs.json'; import dataViewEditorObj from './data_view_editor.devdocs.json';

View file

@ -95,7 +95,7 @@
"section": "def-public.FormatEditorState", "section": "def-public.FormatEditorState",
"text": "FormatEditorState" "text": "FormatEditorState"
}, },
") => { error: any; samples: ", ") => { error: string | undefined; samples: ",
{ {
"pluginId": "dataViewFieldEditor", "pluginId": "dataViewFieldEditor",
"scope": "public", "scope": "public",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor
title: "dataViewFieldEditor" title: "dataViewFieldEditor"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewFieldEditor plugin description: API docs for the dataViewFieldEditor plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
--- ---
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json'; import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement
title: "dataViewManagement" title: "dataViewManagement"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewManagement plugin description: API docs for the dataViewManagement plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
--- ---
import dataViewManagementObj from './data_view_management.devdocs.json'; import dataViewManagementObj from './data_view_management.devdocs.json';

View file

@ -3667,6 +3667,45 @@
"deprecated": false, "deprecated": false,
"trackAdoption": false, "trackAdoption": false,
"children": [ "children": [
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsPublicPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/data_views/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsPublicPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object>"
],
"path": "src/plugins/data_views/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{ {
"parentPluginId": "dataViews", "parentPluginId": "dataViews",
"id": "def-public.DataViewsPublicPlugin.setup", "id": "def-public.DataViewsPublicPlugin.setup",
@ -3914,6 +3953,17 @@
"returnComment": [], "returnComment": [],
"children": [] "children": []
}, },
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsService.scriptedFieldsEnabled",
"type": "boolean",
"tags": [],
"label": "scriptedFieldsEnabled",
"description": [],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false
},
{ {
"parentPluginId": "dataViews", "parentPluginId": "dataViews",
"id": "def-public.DataViewsService.Unnamed", "id": "def-public.DataViewsService.Unnamed",
@ -5474,6 +5524,17 @@
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
}, },
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsServicePublic.scriptedFieldsEnabled",
"type": "boolean",
"tags": [],
"label": "scriptedFieldsEnabled",
"description": [],
"path": "src/plugins/data_views/public/data_views_service_public.ts",
"deprecated": false,
"trackAdoption": false
},
{ {
"parentPluginId": "dataViews", "parentPluginId": "dataViews",
"id": "def-public.DataViewsServicePublic.Unnamed", "id": "def-public.DataViewsServicePublic.Unnamed",
@ -6488,6 +6549,17 @@
} }
], ],
"returnComment": [] "returnComment": []
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsServicePublicDeps.scriptedFieldsEnabled",
"type": "boolean",
"tags": [],
"label": "scriptedFieldsEnabled",
"description": [],
"path": "src/plugins/data_views/public/data_views_service_public.ts",
"deprecated": false,
"trackAdoption": false
} }
], ],
"initialIsOpen": false "initialIsOpen": false
@ -10746,7 +10818,7 @@
"section": "def-common.DataViewsService", "section": "def-common.DataViewsService",
"text": "DataViewsService" "text": "DataViewsService"
}, },
">; }" ">; getScriptedFieldsEnabled: () => boolean; }"
], ],
"path": "src/plugins/data_views/server/plugin.ts", "path": "src/plugins/data_views/server/plugin.ts",
"deprecated": false, "deprecated": false,
@ -10847,6 +10919,17 @@
"returnComment": [], "returnComment": [],
"children": [] "children": []
}, },
{
"parentPluginId": "dataViews",
"id": "def-server.DataViewsService.scriptedFieldsEnabled",
"type": "boolean",
"tags": [],
"label": "scriptedFieldsEnabled",
"description": [],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false
},
{ {
"parentPluginId": "dataViews", "parentPluginId": "dataViews",
"id": "def-server.DataViewsService.Unnamed", "id": "def-server.DataViewsService.Unnamed",
@ -14931,6 +15014,24 @@
"trackAdoption": false "trackAdoption": false
} }
] ]
},
{
"parentPluginId": "dataViews",
"id": "def-server.DataViewsServerPluginStart.getScriptedFieldsEnabled",
"type": "Function",
"tags": [],
"label": "getScriptedFieldsEnabled",
"description": [
"\n"
],
"signature": [
"() => boolean"
],
"path": "src/plugins/data_views/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
} }
], ],
"lifecycle": "start", "lifecycle": "start",
@ -18556,6 +18657,17 @@
"returnComment": [], "returnComment": [],
"children": [] "children": []
}, },
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsService.scriptedFieldsEnabled",
"type": "boolean",
"tags": [],
"label": "scriptedFieldsEnabled",
"description": [],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false
},
{ {
"parentPluginId": "dataViews", "parentPluginId": "dataViews",
"id": "def-common.DataViewsService.Unnamed", "id": "def-common.DataViewsService.Unnamed",
@ -21225,6 +21337,17 @@
"trackAdoption": false, "trackAdoption": false,
"children": [], "children": [],
"returnComment": [] "returnComment": []
},
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsServiceDeps.scriptedFieldsEnabled",
"type": "boolean",
"tags": [],
"label": "scriptedFieldsEnabled",
"description": [],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false
} }
], ],
"initialIsOpen": false "initialIsOpen": false

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews
title: "dataViews" title: "dataViews"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViews plugin description: API docs for the dataViews plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
--- ---
import dataViewsObj from './data_views.devdocs.json'; import dataViewsObj from './data_views.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 1024 | 0 | 246 | 2 | | 1034 | 0 | 254 | 2 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataVisualizer
title: "dataVisualizer" title: "dataVisualizer"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataVisualizer plugin description: API docs for the dataVisualizer plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
--- ---
import dataVisualizerObj from './data_visualizer.devdocs.json'; import dataVisualizerObj from './data_visualizer.devdocs.json';

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
title: Deprecated API usage by API title: Deprecated API usage by API
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage by plugin title: Deprecated API usage by plugin
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, by team title: Deprecated APIs due to be removed, by team
description: Lists the teams that are referencing deprecated APIs with a remove by date. description: Lists the teams that are referencing deprecated APIs with a remove by date.
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools
title: "devTools" title: "devTools"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the devTools plugin description: API docs for the devTools plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
--- ---
import devToolsObj from './dev_tools.devdocs.json'; import devToolsObj from './dev_tools.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover
title: "discover" title: "discover"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the discover plugin description: API docs for the discover plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
--- ---
import discoverObj from './discover.devdocs.json'; import discoverObj from './discover.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced
title: "discoverEnhanced" title: "discoverEnhanced"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the discoverEnhanced plugin description: API docs for the discoverEnhanced plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
--- ---
import discoverEnhancedObj from './discover_enhanced.devdocs.json'; import discoverEnhancedObj from './discover_enhanced.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard
title: "ecsDataQualityDashboard" title: "ecsDataQualityDashboard"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the ecsDataQualityDashboard plugin description: API docs for the ecsDataQualityDashboard plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
--- ---
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json'; import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';

View file

@ -1546,7 +1546,7 @@
"section": "def-common.PanelState", "section": "def-common.PanelState",
"text": "PanelState" "text": "PanelState"
}, },
"<{ id: string; }>) => Promise<TEmbeddable | ", "<{ id: string; version?: string | undefined; }>) => Promise<TEmbeddable | ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "public", "scope": "public",
@ -1590,7 +1590,7 @@
"section": "def-common.PanelState", "section": "def-common.PanelState",
"text": "PanelState" "text": "PanelState"
}, },
"<{ id: string; }>" "<{ id: string; version?: string | undefined; }>"
], ],
"path": "src/plugins/embeddable/public/lib/containers/container.ts", "path": "src/plugins/embeddable/public/lib/containers/container.ts",
"deprecated": false, "deprecated": false,
@ -2169,7 +2169,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"({ embeddable }: ActionContext) => any" "({ embeddable }: ActionContext) => string"
], ],
"path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts",
"deprecated": false, "deprecated": false,
@ -4262,7 +4262,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"() => any" "() => string"
], ],
"path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts",
"deprecated": false, "deprecated": false,
@ -4496,7 +4496,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"() => any" "() => string"
], ],
"path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts",
"deprecated": false, "deprecated": false,
@ -5874,6 +5874,133 @@
"returnComment": [], "returnComment": [],
"initialIsOpen": false "initialIsOpen": false
}, },
{
"parentPluginId": "embeddable",
"id": "def-public.runEmbeddableFactoryMigrations",
"type": "Function",
"tags": [],
"label": "runEmbeddableFactoryMigrations",
"description": [
"\nA helper function that migrates an Embeddable Input to its latest version. Note that this function\nonly runs the embeddable factory's migrations."
],
"signature": [
"<ToType extends ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
">(initialInput: { version?: string | undefined; }, factory: { migrations?: ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.MigrateFunctionsObject",
"text": "MigrateFunctionsObject"
},
" | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.GetMigrationFunctionObjectFn",
"text": "GetMigrationFunctionObjectFn"
},
" | undefined; latestVersion?: string | undefined; }) => { input: ToType; migrationRun: boolean; }"
],
"path": "src/plugins/embeddable/public/lib/factory_migrations/run_factory_migrations.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "embeddable",
"id": "def-public.runEmbeddableFactoryMigrations.$1",
"type": "Object",
"tags": [],
"label": "initialInput",
"description": [],
"path": "src/plugins/embeddable/public/lib/factory_migrations/run_factory_migrations.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "embeddable",
"id": "def-public.runEmbeddableFactoryMigrations.$1.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/embeddable/public/lib/factory_migrations/run_factory_migrations.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "embeddable",
"id": "def-public.runEmbeddableFactoryMigrations.$2",
"type": "Object",
"tags": [],
"label": "factory",
"description": [],
"path": "src/plugins/embeddable/public/lib/factory_migrations/run_factory_migrations.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "embeddable",
"id": "def-public.runEmbeddableFactoryMigrations.$2.migrations",
"type": "CompoundType",
"tags": [],
"label": "migrations",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.MigrateFunctionsObject",
"text": "MigrateFunctionsObject"
},
" | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.GetMigrationFunctionObjectFn",
"text": "GetMigrationFunctionObjectFn"
},
" | undefined"
],
"path": "src/plugins/embeddable/public/lib/factory_migrations/run_factory_migrations.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.runEmbeddableFactoryMigrations.$2.latestVersion",
"type": "string",
"tags": [],
"label": "latestVersion",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/embeddable/public/lib/factory_migrations/run_factory_migrations.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.shouldFetch$", "id": "def-public.shouldFetch$",
@ -6562,6 +6689,22 @@
"deprecated": false, "deprecated": false,
"trackAdoption": false, "trackAdoption": false,
"children": [ "children": [
{
"parentPluginId": "embeddable",
"id": "def-public.EmbeddableFactory.latestVersion",
"type": "string",
"tags": [],
"label": "latestVersion",
"description": [
"\nThe version of this Embeddable factory. This will be used in the client side migration system\nto ensure that input from any source is compatible with the latest version of this embeddable.\nIf the latest version is not defined, all clientside migrations will be skipped. If migrations\nare added to this factory but a latestVersion is not set, an error will be thrown on server start"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"deprecated": false,
"trackAdoption": false
},
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.EmbeddableFactory.type", "id": "def-public.EmbeddableFactory.type",
@ -6916,7 +7059,7 @@
"tags": [], "tags": [],
"label": "create", "label": "create",
"description": [ "description": [
"\nResolves to undefined if a new Embeddable cannot be directly created and the user will instead be redirected\nelsewhere.\n\nThis will likely change in future iterations when we improve in place editing capabilities." "\nCreates an Embeddable instance, running the inital input through all registered migrations. Resolves to undefined if a new Embeddable\ncannot be directly created and the user will instead be redirected elsewhere."
], ],
"signature": [ "signature": [
"(initialInput: TEmbeddableInput, parent?: ", "(initialInput: TEmbeddableInput, parent?: ",
@ -9293,20 +9436,6 @@
"path": "src/plugins/embeddable/common/types.ts", "path": "src/plugins/embeddable/common/types.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.PanelState.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/embeddable/common/types.ts",
"deprecated": false,
"trackAdoption": false
} }
], ],
"initialIsOpen": false "initialIsOpen": false
@ -9845,7 +9974,7 @@
"section": "def-public.EmbeddableFactory", "section": "def-public.EmbeddableFactory",
"text": "EmbeddableFactory" "text": "EmbeddableFactory"
}, },
"<I, O, E, T>, \"create\" | \"type\" | \"isEditable\" | \"getDisplayName\"> & Partial<Pick<", "<I, O, E, T>, \"create\" | \"type\" | \"latestVersion\" | \"isEditable\" | \"getDisplayName\"> & Partial<Pick<",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "public", "scope": "public",
@ -9868,7 +9997,7 @@
"label": "EmbeddableInput", "label": "EmbeddableInput",
"description": [], "description": [],
"signature": [ "signature": [
"{ viewMode?: ", "{ version?: string | undefined; viewMode?: ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "common", "scope": "common",
@ -10065,13 +10194,10 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.cellValueTrigger.title", "id": "def-public.cellValueTrigger.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -10079,13 +10205,10 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.cellValueTrigger.description", "id": "def-public.cellValueTrigger.description",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "description", "label": "description",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -10118,13 +10241,10 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.contextMenuTrigger.title", "id": "def-public.contextMenuTrigger.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -10132,13 +10252,10 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.contextMenuTrigger.description", "id": "def-public.contextMenuTrigger.description",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "description", "label": "description",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -10171,13 +10288,10 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.panelBadgeTrigger.title", "id": "def-public.panelBadgeTrigger.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -10185,13 +10299,10 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.panelBadgeTrigger.description", "id": "def-public.panelBadgeTrigger.description",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "description", "label": "description",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -10224,13 +10335,10 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.panelHoverTrigger.title", "id": "def-public.panelHoverTrigger.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -10238,13 +10346,10 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.panelHoverTrigger.description", "id": "def-public.panelHoverTrigger.description",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "description", "label": "description",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -10277,13 +10382,10 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.panelNotificationTrigger.title", "id": "def-public.panelNotificationTrigger.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -10291,13 +10393,10 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.panelNotificationTrigger.description", "id": "def-public.panelNotificationTrigger.description",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "description", "label": "description",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -11481,20 +11580,6 @@
"path": "src/plugins/embeddable/common/types.ts", "path": "src/plugins/embeddable/common/types.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
},
{
"parentPluginId": "embeddable",
"id": "def-common.PanelState.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/embeddable/common/types.ts",
"deprecated": false,
"trackAdoption": false
} }
], ],
"initialIsOpen": false "initialIsOpen": false
@ -11565,7 +11650,7 @@
"label": "EmbeddableInput", "label": "EmbeddableInput",
"description": [], "description": [],
"signature": [ "signature": [
"{ viewMode?: ", "{ version?: string | undefined; viewMode?: ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "common", "scope": "common",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable
title: "embeddable" title: "embeddable"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddable plugin description: API docs for the embeddable plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
--- ---
import embeddableObj from './embeddable.devdocs.json'; import embeddableObj from './embeddable.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 537 | 11 | 439 | 7 | | 542 | 1 | 442 | 7 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced
title: "embeddableEnhanced" title: "embeddableEnhanced"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddableEnhanced plugin description: API docs for the embeddableEnhanced plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
--- ---
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json'; import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
title: "encryptedSavedObjects" title: "encryptedSavedObjects"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the encryptedSavedObjects plugin description: API docs for the encryptedSavedObjects plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
--- ---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json'; import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch
title: "enterpriseSearch" title: "enterpriseSearch"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the enterpriseSearch plugin description: API docs for the enterpriseSearch plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
--- ---
import enterpriseSearchObj from './enterprise_search.devdocs.json'; import enterpriseSearchObj from './enterprise_search.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared
title: "esUiShared" title: "esUiShared"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the esUiShared plugin description: API docs for the esUiShared plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
--- ---
import esUiSharedObj from './es_ui_shared.devdocs.json'; import esUiSharedObj from './es_ui_shared.devdocs.json';

View file

@ -382,7 +382,7 @@
"section": "def-common.EventAnnotationGroupConfig", "section": "def-common.EventAnnotationGroupConfig",
"text": "EventAnnotationGroupConfig" "text": "EventAnnotationGroupConfig"
}, },
", \"annotations\" | \"ignoreGlobalFilters\" | \"indexPatternId\">[]; }) => ", ", \"ignoreGlobalFilters\" | \"annotations\" | \"indexPatternId\">[]; }) => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
"scope": "common", "scope": "common",
@ -434,7 +434,7 @@
"section": "def-common.EventAnnotationGroupConfig", "section": "def-common.EventAnnotationGroupConfig",
"text": "EventAnnotationGroupConfig" "text": "EventAnnotationGroupConfig"
}, },
", \"annotations\" | \"ignoreGlobalFilters\" | \"indexPatternId\">[]" ", \"ignoreGlobalFilters\" | \"annotations\" | \"indexPatternId\">[]"
], ],
"path": "packages/kbn-event-annotation-components/types.ts", "path": "packages/kbn-event-annotation-components/types.ts",
"deprecated": false, "deprecated": false,
@ -1473,13 +1473,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.help", "id": "def-common.manualPointEventAnnotation.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1551,13 +1548,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.id.help", "id": "def-common.manualPointEventAnnotation.args.id.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1592,13 +1586,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.time.help", "id": "def-common.manualPointEventAnnotation.args.time.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1633,13 +1624,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.label.help", "id": "def-common.manualPointEventAnnotation.args.label.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1674,13 +1662,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.color.help", "id": "def-common.manualPointEventAnnotation.args.color.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1729,13 +1714,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.lineStyle.help", "id": "def-common.manualPointEventAnnotation.args.lineStyle.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1770,13 +1752,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.lineWidth.help", "id": "def-common.manualPointEventAnnotation.args.lineWidth.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1811,13 +1790,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.icon.help", "id": "def-common.manualPointEventAnnotation.args.icon.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1880,13 +1856,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.textVisibility.help", "id": "def-common.manualPointEventAnnotation.args.textVisibility.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1921,13 +1894,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.isHidden.help", "id": "def-common.manualPointEventAnnotation.args.isHidden.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2080,13 +2050,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.help", "id": "def-common.manualRangeEventAnnotation.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2158,13 +2125,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.id.help", "id": "def-common.manualRangeEventAnnotation.args.id.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2199,13 +2163,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.time.help", "id": "def-common.manualRangeEventAnnotation.args.time.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2240,13 +2201,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.endTime.help", "id": "def-common.manualRangeEventAnnotation.args.endTime.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2347,13 +2305,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.label.help", "id": "def-common.manualRangeEventAnnotation.args.label.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2388,13 +2343,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.color.help", "id": "def-common.manualRangeEventAnnotation.args.color.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2429,13 +2381,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.isHidden.help", "id": "def-common.manualRangeEventAnnotation.args.isHidden.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2556,13 +2505,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.help", "id": "def-common.queryPointEventAnnotation.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2634,13 +2580,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.id.help", "id": "def-common.queryPointEventAnnotation.args.id.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2675,13 +2618,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.filter.help", "id": "def-common.queryPointEventAnnotation.args.filter.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2730,13 +2670,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.extraFields.help", "id": "def-common.queryPointEventAnnotation.args.extraFields.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2771,13 +2708,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.timeField.help", "id": "def-common.queryPointEventAnnotation.args.timeField.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2812,13 +2746,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.label.help", "id": "def-common.queryPointEventAnnotation.args.label.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2853,13 +2784,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.color.help", "id": "def-common.queryPointEventAnnotation.args.color.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2908,13 +2836,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.lineStyle.help", "id": "def-common.queryPointEventAnnotation.args.lineStyle.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2949,13 +2874,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.lineWidth.help", "id": "def-common.queryPointEventAnnotation.args.lineWidth.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2990,13 +2912,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.icon.help", "id": "def-common.queryPointEventAnnotation.args.icon.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3059,13 +2978,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.textVisibility.help", "id": "def-common.queryPointEventAnnotation.args.textVisibility.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3100,13 +3016,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.textField.help", "id": "def-common.queryPointEventAnnotation.args.textField.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3141,13 +3054,10 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.isHidden.help", "id": "def-common.queryPointEventAnnotation.args.isHidden.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
title: "eventAnnotation" title: "eventAnnotation"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotation plugin description: API docs for the eventAnnotation plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
--- ---
import eventAnnotationObj from './event_annotation.devdocs.json'; import eventAnnotationObj from './event_annotation.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 195 | 30 | 195 | 5 | | 195 | 0 | 195 | 5 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog
title: "eventLog" title: "eventLog"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the eventLog plugin description: API docs for the eventLog plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
--- ---
import eventLogObj from './event_log.devdocs.json'; import eventLogObj from './event_log.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/exploratoryView
title: "exploratoryView" title: "exploratoryView"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the exploratoryView plugin description: API docs for the exploratoryView plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
--- ---
import exploratoryViewObj from './exploratory_view.devdocs.json'; import exploratoryViewObj from './exploratory_view.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError
title: "expressionError" title: "expressionError"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionError plugin description: API docs for the expressionError plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
--- ---
import expressionErrorObj from './expression_error.devdocs.json'; import expressionErrorObj from './expression_error.devdocs.json';

View file

@ -1231,7 +1231,7 @@
"section": "def-common.MakeOverridesSerializable", "section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable" "text": "MakeOverridesSerializable"
}, },
"<string[] | undefined>; tooltipValueFormatter?: \"ignore\" | undefined; }>> & Partial<Record<\"settings\", { debug?: boolean | undefined; theme?: ", "<string[] | undefined>; tooltipValueFormatter?: \"ignore\" | undefined; }>> & Partial<Record<\"settings\", { theme?: ",
"MakeOverridesSerializable", "MakeOverridesSerializable",
"<", "<",
"RecursivePartial", "RecursivePartial",
@ -1247,7 +1247,7 @@
"LegendPositionConfig", "LegendPositionConfig",
" | undefined; rotation?: ", " | undefined; rotation?: ",
"Rotation", "Rotation",
" | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ", " | undefined; debug?: boolean | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ",
"Rendering", "Rendering",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ", " | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable", "MakeOverridesSerializable",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionGauge
title: "expressionGauge" title: "expressionGauge"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionGauge plugin description: API docs for the expressionGauge plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
--- ---
import expressionGaugeObj from './expression_gauge.devdocs.json'; import expressionGaugeObj from './expression_gauge.devdocs.json';

View file

@ -493,7 +493,7 @@
"label": "overrides", "label": "overrides",
"description": [], "description": [],
"signature": [ "signature": [
"(Partial<Record<\"settings\", { debug?: boolean | undefined; theme?: ", "(Partial<Record<\"settings\", { theme?: ",
"MakeOverridesSerializable", "MakeOverridesSerializable",
"<", "<",
"RecursivePartial", "RecursivePartial",
@ -509,7 +509,7 @@
"LegendPositionConfig", "LegendPositionConfig",
" | undefined; rotation?: ", " | undefined; rotation?: ",
"Rotation", "Rotation",
" | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ", " | undefined; debug?: boolean | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ",
"Rendering", "Rendering",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ", " | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable", "MakeOverridesSerializable",
@ -1087,13 +1087,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.strokeWidth.help", "id": "def-common.heatmapGridConfig.args.strokeWidth.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1142,13 +1139,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.strokeColor.help", "id": "def-common.heatmapGridConfig.args.strokeColor.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1199,13 +1193,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.isCellLabelVisible.help", "id": "def-common.heatmapGridConfig.args.isCellLabelVisible.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1242,13 +1233,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.isYAxisLabelVisible.help", "id": "def-common.heatmapGridConfig.args.isYAxisLabelVisible.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1283,13 +1271,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.isYAxisTitleVisible.help", "id": "def-common.heatmapGridConfig.args.isYAxisTitleVisible.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1324,13 +1309,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.yTitle.help", "id": "def-common.heatmapGridConfig.args.yTitle.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1381,13 +1363,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.isXAxisLabelVisible.help", "id": "def-common.heatmapGridConfig.args.isXAxisLabelVisible.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1422,13 +1401,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.isXAxisTitleVisible.help", "id": "def-common.heatmapGridConfig.args.isXAxisTitleVisible.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1463,13 +1439,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.xTitle.help", "id": "def-common.heatmapGridConfig.args.xTitle.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1661,13 +1634,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapLegendConfig.args.isVisible.help", "id": "def-common.heatmapLegendConfig.args.isVisible.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1730,13 +1700,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapLegendConfig.args.position.help", "id": "def-common.heatmapLegendConfig.args.position.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1785,13 +1752,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapLegendConfig.args.maxLines.help", "id": "def-common.heatmapLegendConfig.args.maxLines.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1840,13 +1804,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapLegendConfig.args.shouldTruncate.help", "id": "def-common.heatmapLegendConfig.args.shouldTruncate.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1901,13 +1862,10 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapLegendConfig.args.legendSize.help", "id": "def-common.heatmapLegendConfig.args.legendSize.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap
title: "expressionHeatmap" title: "expressionHeatmap"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionHeatmap plugin description: API docs for the expressionHeatmap plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
--- ---
import expressionHeatmapObj from './expression_heatmap.devdocs.json'; import expressionHeatmapObj from './expression_heatmap.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 112 | 14 | 108 | 2 | | 112 | 0 | 108 | 2 |
## Common ## Common

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage
title: "expressionImage" title: "expressionImage"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionImage plugin description: API docs for the expressionImage plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
--- ---
import expressionImageObj from './expression_image.devdocs.json'; import expressionImageObj from './expression_image.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis
title: "expressionLegacyMetricVis" title: "expressionLegacyMetricVis"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionLegacyMetricVis plugin description: API docs for the expressionLegacyMetricVis plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
--- ---
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json'; import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';

View file

@ -192,7 +192,7 @@
"label": "metricFunction", "label": "metricFunction",
"description": [], "description": [],
"signature": [ "signature": [
"() => { name: \"metric\"; aliases: never[]; type: \"render\"; inputTypes: (\"string\" | \"number\" | \"null\")[]; help: any; args: { label: { types: \"string\"[]; aliases: string[]; help: any; default: string; }; labelFont: { types: \"style\"[]; help: any; default: string; }; metricFont: { types: \"style\"[]; help: any; default: string; }; metricFormat: { types: \"string\"[]; aliases: string[]; help: any; }; }; fn: (input: ", "() => { name: \"metric\"; aliases: never[]; type: \"render\"; inputTypes: (\"string\" | \"number\" | \"null\")[]; help: string; args: { label: { types: \"string\"[]; aliases: string[]; help: string; default: string; }; labelFont: { types: \"style\"[]; help: string; default: string; }; metricFont: { types: \"style\"[]; help: string; default: string; }; metricFormat: { types: \"string\"[]; aliases: string[]; help: string; }; }; fn: (input: ",
{ {
"pluginId": "expressionMetric", "pluginId": "expressionMetric",
"scope": "common", "scope": "common",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric
title: "expressionMetric" title: "expressionMetric"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetric plugin description: API docs for the expressionMetric plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
--- ---
import expressionMetricObj from './expression_metric.devdocs.json'; import expressionMetricObj from './expression_metric.devdocs.json';

View file

@ -868,7 +868,7 @@
"label": "overrides", "label": "overrides",
"description": [], "description": [],
"signature": [ "signature": [
"(Partial<Record<\"settings\", { debug?: boolean | undefined; theme?: ", "(Partial<Record<\"settings\", { theme?: ",
"MakeOverridesSerializable", "MakeOverridesSerializable",
"<", "<",
"RecursivePartial", "RecursivePartial",
@ -884,7 +884,7 @@
"LegendPositionConfig", "LegendPositionConfig",
" | undefined; rotation?: ", " | undefined; rotation?: ",
"Rotation", "Rotation",
" | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ", " | undefined; debug?: boolean | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ",
"Rendering", "Rendering",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ", " | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable", "MakeOverridesSerializable",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis
title: "expressionMetricVis" title: "expressionMetricVis"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetricVis plugin description: API docs for the expressionMetricVis plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
--- ---
import expressionMetricVisObj from './expression_metric_vis.devdocs.json'; import expressionMetricVisObj from './expression_metric_vis.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis
title: "expressionPartitionVis" title: "expressionPartitionVis"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionPartitionVis plugin description: API docs for the expressionPartitionVis plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
--- ---
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json'; import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';

View file

@ -192,7 +192,7 @@
"label": "repeatImageFunction", "label": "repeatImageFunction",
"description": [], "description": [],
"signature": [ "signature": [
"() => { name: \"repeatImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: any; args: { emptyImage: { types: (\"string\" | \"null\")[]; help: any; default: null; }; image: { types: (\"string\" | \"null\")[]; help: any; default: null; }; max: { types: (\"number\" | \"null\")[]; help: any; default: number; }; size: { types: \"number\"[]; default: number; help: any; }; }; fn: (count: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string | null; emptyImage: string | null; size: number; max: number | null; count: number; }; }>; }" "() => { name: \"repeatImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: string; args: { emptyImage: { types: (\"string\" | \"null\")[]; help: string; default: null; }; image: { types: (\"string\" | \"null\")[]; help: string; default: null; }; max: { types: (\"number\" | \"null\")[]; help: string; default: number; }; size: { types: \"number\"[]; default: number; help: string; }; }; fn: (count: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string | null; emptyImage: string | null; size: number; max: number | null; count: number; }; }>; }"
], ],
"path": "src/plugins/expression_repeat_image/common/expression_functions/repeat_image_function.ts", "path": "src/plugins/expression_repeat_image/common/expression_functions/repeat_image_function.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage
title: "expressionRepeatImage" title: "expressionRepeatImage"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRepeatImage plugin description: API docs for the expressionRepeatImage plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
--- ---
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json'; import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';

View file

@ -180,7 +180,7 @@
"label": "revealImageFunction", "label": "revealImageFunction",
"description": [], "description": [],
"signature": [ "signature": [
"() => { name: \"revealImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: any; args: { image: { types: (\"string\" | \"null\")[]; help: any; default: null; }; emptyImage: { types: (\"string\" | \"null\")[]; help: any; default: null; }; origin: { types: \"string\"[]; help: any; default: string; options: ", "() => { name: \"revealImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: string; args: { image: { types: (\"string\" | \"null\")[]; help: string; default: null; }; emptyImage: { types: (\"string\" | \"null\")[]; help: string; default: null; }; origin: { types: \"string\"[]; help: string; default: string; options: ",
"Origin", "Origin",
"[]; }; }; fn: (percent: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string; emptyImage: string; origin: ", "[]; }; }; fn: (percent: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string; emptyImage: string; origin: ",
"Origin", "Origin",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage
title: "expressionRevealImage" title: "expressionRevealImage"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRevealImage plugin description: API docs for the expressionRevealImage plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
--- ---
import expressionRevealImageObj from './expression_reveal_image.devdocs.json'; import expressionRevealImageObj from './expression_reveal_image.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape
title: "expressionShape" title: "expressionShape"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionShape plugin description: API docs for the expressionShape plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
--- ---
import expressionShapeObj from './expression_shape.devdocs.json'; import expressionShapeObj from './expression_shape.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud
title: "expressionTagcloud" title: "expressionTagcloud"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionTagcloud plugin description: API docs for the expressionTagcloud plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
--- ---
import expressionTagcloudObj from './expression_tagcloud.devdocs.json'; import expressionTagcloudObj from './expression_tagcloud.devdocs.json';

View file

@ -1916,7 +1916,7 @@
}, },
"<", "<",
"YDomainRange", "YDomainRange",
" | undefined>; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; }>> & Partial<Record<\"settings\", { debug?: boolean | undefined; theme?: ", " | undefined>; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; }>> & Partial<Record<\"settings\", { theme?: ",
"MakeOverridesSerializable", "MakeOverridesSerializable",
"<", "<",
"RecursivePartial", "RecursivePartial",
@ -1932,7 +1932,7 @@
"LegendPositionConfig", "LegendPositionConfig",
" | undefined; rotation?: ", " | undefined; rotation?: ",
"Rotation", "Rotation",
" | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ", " | undefined; debug?: boolean | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ",
"Rendering", "Rendering",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ", " | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable", "MakeOverridesSerializable",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionXY
title: "expressionXY" title: "expressionXY"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionXY plugin description: API docs for the expressionXY plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
--- ---
import expressionXYObj from './expression_x_y.devdocs.json'; import expressionXYObj from './expression_x_y.devdocs.json';

View file

@ -38608,13 +38608,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.createTable.help", "id": "def-common.createTable.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -38658,13 +38655,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.createTable.args.ids.help", "id": "def-common.createTable.args.ids.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -38727,13 +38721,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.createTable.args.names.help", "id": "def-common.createTable.args.names.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -38796,13 +38787,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.createTable.args.rowCount.help", "id": "def-common.createTable.args.rowCount.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -38966,13 +38954,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.cumulativeSum.help", "id": "def-common.cumulativeSum.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -39002,13 +38987,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.cumulativeSum.args.by.help", "id": "def-common.cumulativeSum.args.by.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -39071,13 +39053,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.cumulativeSum.args.inputColumnId.help", "id": "def-common.cumulativeSum.args.inputColumnId.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -39126,13 +39105,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.cumulativeSum.args.outputColumnId.help", "id": "def-common.cumulativeSum.args.outputColumnId.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -39181,13 +39157,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.cumulativeSum.args.outputColumnName.help", "id": "def-common.cumulativeSum.args.outputColumnName.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -39795,13 +39768,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.derivative.help", "id": "def-common.derivative.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -39831,13 +39801,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.derivative.args.by.help", "id": "def-common.derivative.args.by.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -39900,13 +39867,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.derivative.args.inputColumnId.help", "id": "def-common.derivative.args.inputColumnId.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -39955,13 +39919,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.derivative.args.outputColumnId.help", "id": "def-common.derivative.args.outputColumnId.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -40010,13 +39971,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.derivative.args.outputColumnName.help", "id": "def-common.derivative.args.outputColumnName.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -40597,13 +40555,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.font.help", "id": "def-common.font.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "path": "src/plugins/expressions/common/expression_functions/specs/font.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -40658,13 +40613,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.font.args.align.help", "id": "def-common.font.args.align.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "path": "src/plugins/expressions/common/expression_functions/specs/font.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -40731,13 +40683,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.font.args.color.help", "id": "def-common.font.args.color.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "path": "src/plugins/expressions/common/expression_functions/specs/font.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -40783,13 +40732,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.font.args.family.help", "id": "def-common.font.args.family.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "path": "src/plugins/expressions/common/expression_functions/specs/font.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -40835,13 +40781,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.font.args.italic.help", "id": "def-common.font.args.italic.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "path": "src/plugins/expressions/common/expression_functions/specs/font.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -40915,13 +40858,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.font.args.lHeight.help", "id": "def-common.font.args.lHeight.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "path": "src/plugins/expressions/common/expression_functions/specs/font.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -40967,13 +40907,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.font.args.size.help", "id": "def-common.font.args.size.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "path": "src/plugins/expressions/common/expression_functions/specs/font.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -41019,13 +40956,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.font.args.sizeUnit.help", "id": "def-common.font.args.sizeUnit.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "path": "src/plugins/expressions/common/expression_functions/specs/font.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -41085,13 +41019,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.font.args.underline.help", "id": "def-common.font.args.underline.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "path": "src/plugins/expressions/common/expression_functions/specs/font.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -41151,13 +41082,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.font.args.weight.help", "id": "def-common.font.args.weight.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "path": "src/plugins/expressions/common/expression_functions/specs/font.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -41536,13 +41464,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.mapColumn.help", "id": "def-common.mapColumn.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -41586,13 +41511,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.mapColumn.args.id.help", "id": "def-common.mapColumn.args.id.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -41669,13 +41591,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.mapColumn.args.name.help", "id": "def-common.mapColumn.args.name.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -41752,13 +41671,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.mapColumn.args.expression.help", "id": "def-common.mapColumn.args.expression.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -41807,13 +41723,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.mapColumn.args.copyMetaFrom.help", "id": "def-common.mapColumn.args.copyMetaFrom.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -42012,13 +41925,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.math.help", "id": "def-common.math.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "path": "src/plugins/expressions/common/expression_functions/specs/math.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -42076,13 +41986,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.math.args.expression.help", "id": "def-common.math.args.expression.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "path": "src/plugins/expressions/common/expression_functions/specs/math.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -42131,13 +42038,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.math.args.onError.help", "id": "def-common.math.args.onError.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "path": "src/plugins/expressions/common/expression_functions/specs/math.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -42280,13 +42184,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.mathColumn.help", "id": "def-common.mathColumn.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -42344,13 +42245,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.mathColumn.args.id.help", "id": "def-common.mathColumn.args.id.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -42413,13 +42311,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.mathColumn.args.name.help", "id": "def-common.mathColumn.args.name.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -42482,13 +42377,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.mathColumn.args.castColumns.help", "id": "def-common.mathColumn.args.castColumns.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -42537,13 +42429,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.mathColumn.args.copyMetaFrom.help", "id": "def-common.mathColumn.args.copyMetaFrom.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -42786,13 +42675,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.movingAverage.help", "id": "def-common.movingAverage.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -42822,13 +42708,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.movingAverage.args.by.help", "id": "def-common.movingAverage.args.by.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -42891,13 +42774,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.movingAverage.args.inputColumnId.help", "id": "def-common.movingAverage.args.inputColumnId.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -42946,13 +42826,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.movingAverage.args.outputColumnId.help", "id": "def-common.movingAverage.args.outputColumnId.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -43001,13 +42878,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.movingAverage.args.outputColumnName.help", "id": "def-common.movingAverage.args.outputColumnName.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -43056,13 +42930,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.movingAverage.args.window.help", "id": "def-common.movingAverage.args.window.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -43818,13 +43689,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.overallMetric.help", "id": "def-common.overallMetric.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -43854,13 +43722,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.overallMetric.args.by.help", "id": "def-common.overallMetric.args.by.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -43923,13 +43788,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.overallMetric.args.metric.help", "id": "def-common.overallMetric.args.metric.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -43978,13 +43840,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.overallMetric.args.inputColumnId.help", "id": "def-common.overallMetric.args.inputColumnId.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -44033,13 +43892,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.overallMetric.args.outputColumnId.help", "id": "def-common.overallMetric.args.outputColumnId.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -44088,13 +43944,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.overallMetric.args.outputColumnName.help", "id": "def-common.overallMetric.args.outputColumnName.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -45355,13 +45208,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.theme.help", "id": "def-common.theme.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -45419,13 +45269,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.theme.args.variable.help", "id": "def-common.theme.args.variable.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -45474,13 +45321,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.theme.args.default.help", "id": "def-common.theme.args.default.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -45915,13 +45759,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.variable.help", "id": "def-common.variable.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "path": "src/plugins/expressions/common/expression_functions/specs/var.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -45993,13 +45834,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.variable.args.name.help", "id": "def-common.variable.args.name.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "path": "src/plugins/expressions/common/expression_functions/specs/var.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -46148,13 +45986,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.variableSet.help", "id": "def-common.variableSet.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -46240,13 +46075,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.variableSet.args.name.help", "id": "def-common.variableSet.args.name.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -46295,13 +46127,10 @@
{ {
"parentPluginId": "expressions", "parentPluginId": "expressions",
"id": "def-common.variableSet.args.value.help", "id": "def-common.variableSet.args.value.help",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions
title: "expressions" title: "expressions"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressions plugin description: API docs for the expressions plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
--- ---
import expressionsObj from './expressions.devdocs.json'; import expressionsObj from './expressions.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 2205 | 74 | 1746 | 5 | | 2205 | 17 | 1746 | 5 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features
title: "features" title: "features"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the features plugin description: API docs for the features plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
--- ---
import featuresObj from './features.devdocs.json'; import featuresObj from './features.devdocs.json';

View file

@ -53,13 +53,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-public.DateFormat.title", "id": "def-public.DateFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/public/lib/converters/date.ts", "path": "src/plugins/field_formats/public/lib/converters/date.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -196,13 +193,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-public.DateNanosFormat.title", "id": "def-public.DateNanosFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/date_nanos_shared.ts", "path": "src/plugins/field_formats/common/converters/date_nanos_shared.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -454,13 +448,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-server.DateFormat.title", "id": "def-server.DateFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/server/lib/converters/date_server.ts", "path": "src/plugins/field_formats/server/lib/converters/date_server.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -939,13 +930,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.BoolFormat.title", "id": "def-common.BoolFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/boolean.ts", "path": "src/plugins/field_formats/common/converters/boolean.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1081,13 +1069,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.BytesFormat.title", "id": "def-common.BytesFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/bytes.ts", "path": "src/plugins/field_formats/common/converters/bytes.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1115,13 +1100,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.BytesFormat.title", "id": "def-common.BytesFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/bytes.ts", "path": "src/plugins/field_formats/common/converters/bytes.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1191,13 +1173,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.ColorFormat.title", "id": "def-common.ColorFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/color.tsx", "path": "src/plugins/field_formats/common/converters/color.tsx",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1387,13 +1366,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.DurationFormat.title", "id": "def-common.DurationFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/duration.ts", "path": "src/plugins/field_formats/common/converters/duration.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1426,7 +1402,7 @@
"label": "inputFormats", "label": "inputFormats",
"description": [], "description": [],
"signature": [ "signature": [
"{ text: any; kind: string; }[]" "{ text: string; kind: string; }[]"
], ],
"path": "src/plugins/field_formats/common/converters/duration.ts", "path": "src/plugins/field_formats/common/converters/duration.ts",
"deprecated": false, "deprecated": false,
@ -1440,7 +1416,7 @@
"label": "outputFormats", "label": "outputFormats",
"description": [], "description": [],
"signature": [ "signature": [
"({ text: any; method: string; shortText?: undefined; } | { text: any; shortText: any; method: string; })[]" "({ text: string; method: string; shortText?: undefined; } | { text: string; shortText: string; method: string; })[]"
], ],
"path": "src/plugins/field_formats/common/converters/duration.ts", "path": "src/plugins/field_formats/common/converters/duration.ts",
"deprecated": false, "deprecated": false,
@ -3613,13 +3589,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.GeoPointFormat.title", "id": "def-common.GeoPointFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/geo_point.ts", "path": "src/plugins/field_formats/common/converters/geo_point.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3653,7 +3626,7 @@
"label": "transformOptions", "label": "transformOptions",
"description": [], "description": [],
"signature": [ "signature": [
"{ kind: string; text: any; }[]" "{ kind: string; text: string; }[]"
], ],
"path": "src/plugins/field_formats/common/converters/geo_point.ts", "path": "src/plugins/field_formats/common/converters/geo_point.ts",
"deprecated": false, "deprecated": false,
@ -3811,13 +3784,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.HistogramFormat.title", "id": "def-common.HistogramFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/histogram.ts", "path": "src/plugins/field_formats/common/converters/histogram.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3845,13 +3815,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.HistogramFormat.title", "id": "def-common.HistogramFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/histogram.ts", "path": "src/plugins/field_formats/common/converters/histogram.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3999,13 +3966,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.IpFormat.title", "id": "def-common.IpFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/ip.ts", "path": "src/plugins/field_formats/common/converters/ip.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -4110,13 +4074,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.NumberFormat.title", "id": "def-common.NumberFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/number.ts", "path": "src/plugins/field_formats/common/converters/number.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -4144,13 +4105,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.NumberFormat.title", "id": "def-common.NumberFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/number.ts", "path": "src/plugins/field_formats/common/converters/number.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -4214,13 +4172,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.PercentFormat.title", "id": "def-common.PercentFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/percent.ts", "path": "src/plugins/field_formats/common/converters/percent.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -4248,13 +4203,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.PercentFormat.title", "id": "def-common.PercentFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/percent.ts", "path": "src/plugins/field_formats/common/converters/percent.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -4380,13 +4332,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.RelativeDateFormat.title", "id": "def-common.RelativeDateFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/relative_date.ts", "path": "src/plugins/field_formats/common/converters/relative_date.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -4497,13 +4446,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.StaticLookupFormat.title", "id": "def-common.StaticLookupFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/static_lookup.ts", "path": "src/plugins/field_formats/common/converters/static_lookup.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -4631,13 +4577,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.StringFormat.title", "id": "def-common.StringFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/string.ts", "path": "src/plugins/field_formats/common/converters/string.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -4671,7 +4614,7 @@
"label": "transformOptions", "label": "transformOptions",
"description": [], "description": [],
"signature": [ "signature": [
"({ kind: boolean; text: any; } | { kind: string; text: any; })[]" "({ kind: boolean; text: string; } | { kind: string; text: string; })[]"
], ],
"path": "src/plugins/field_formats/common/converters/string.ts", "path": "src/plugins/field_formats/common/converters/string.ts",
"deprecated": false, "deprecated": false,
@ -4709,7 +4652,7 @@
"section": "def-common.TextContextTypeOptions", "section": "def-common.TextContextTypeOptions",
"text": "TextContextTypeOptions" "text": "TextContextTypeOptions"
}, },
" | undefined) => any" " | undefined) => string"
], ],
"path": "src/plugins/field_formats/common/converters/string.ts", "path": "src/plugins/field_formats/common/converters/string.ts",
"deprecated": false, "deprecated": false,
@ -4871,13 +4814,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.TruncateFormat.title", "id": "def-common.TruncateFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/truncate.ts", "path": "src/plugins/field_formats/common/converters/truncate.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -4988,13 +4928,10 @@
{ {
"parentPluginId": "fieldFormats", "parentPluginId": "fieldFormats",
"id": "def-common.UrlFormat.title", "id": "def-common.UrlFormat.title",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/field_formats/common/converters/url.ts", "path": "src/plugins/field_formats/common/converters/url.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -5028,7 +4965,7 @@
"label": "urlTypes", "label": "urlTypes",
"description": [], "description": [],
"signature": [ "signature": [
"{ kind: string; text: any; }[]" "{ kind: string; text: string; }[]"
], ],
"path": "src/plugins/field_formats/common/converters/url.ts", "path": "src/plugins/field_formats/common/converters/url.ts",
"deprecated": false, "deprecated": false,
@ -5542,7 +5479,7 @@
"label": "DURATION_INPUT_FORMATS", "label": "DURATION_INPUT_FORMATS",
"description": [], "description": [],
"signature": [ "signature": [
"{ text: any; kind: string; }[]" "{ text: string; kind: string; }[]"
], ],
"path": "src/plugins/field_formats/common/constants/duration_formats.ts", "path": "src/plugins/field_formats/common/constants/duration_formats.ts",
"deprecated": false, "deprecated": false,
@ -5557,7 +5494,7 @@
"label": "DURATION_OUTPUT_FORMATS", "label": "DURATION_OUTPUT_FORMATS",
"description": [], "description": [],
"signature": [ "signature": [
"({ text: any; method: string; shortText?: undefined; } | { text: any; shortText: any; method: string; })[]" "({ text: string; method: string; shortText?: undefined; } | { text: string; shortText: string; method: string; })[]"
], ],
"path": "src/plugins/field_formats/common/constants/duration_formats.ts", "path": "src/plugins/field_formats/common/constants/duration_formats.ts",
"deprecated": false, "deprecated": false,
@ -6652,7 +6589,7 @@
"label": "DEFAULT_DURATION_INPUT_FORMAT", "label": "DEFAULT_DURATION_INPUT_FORMAT",
"description": [], "description": [],
"signature": [ "signature": [
"{ text: any; kind: string; }" "{ text: string; kind: string; }"
], ],
"path": "src/plugins/field_formats/common/constants/duration_formats.ts", "path": "src/plugins/field_formats/common/constants/duration_formats.ts",
"deprecated": false, "deprecated": false,
@ -6667,7 +6604,7 @@
"label": "DEFAULT_DURATION_OUTPUT_FORMAT", "label": "DEFAULT_DURATION_OUTPUT_FORMAT",
"description": [], "description": [],
"signature": [ "signature": [
"{ text: any; method: string; }" "{ text: string; method: string; }"
], ],
"path": "src/plugins/field_formats/common/constants/duration_formats.ts", "path": "src/plugins/field_formats/common/constants/duration_formats.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats
title: "fieldFormats" title: "fieldFormats"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldFormats plugin description: API docs for the fieldFormats plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
--- ---
import fieldFormatsObj from './field_formats.devdocs.json'; import fieldFormatsObj from './field_formats.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 292 | 26 | 253 | 3 | | 292 | 5 | 253 | 3 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload
title: "fileUpload" title: "fileUpload"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the fileUpload plugin description: API docs for the fileUpload plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
--- ---
import fileUploadObj from './file_upload.devdocs.json'; import fileUploadObj from './file_upload.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/files
title: "files" title: "files"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the files plugin description: API docs for the files plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
--- ---
import filesObj from './files.devdocs.json'; import filesObj from './files.devdocs.json';

View file

@ -40,13 +40,10 @@
{ {
"parentPluginId": "filesManagement", "parentPluginId": "filesManagement",
"id": "def-common.PLUGIN_NAME", "id": "def-common.PLUGIN_NAME",
"type": "Any", "type": "string",
"tags": [], "tags": [],
"label": "PLUGIN_NAME", "label": "PLUGIN_NAME",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/files_management/common/index.ts", "path": "src/plugins/files_management/common/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false, "trackAdoption": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement
title: "filesManagement" title: "filesManagement"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the filesManagement plugin description: API docs for the filesManagement plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
--- ---
import filesManagementObj from './files_management.devdocs.json'; import filesManagementObj from './files_management.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 2 | 1 | 2 | 0 | | 2 | 0 | 2 | 0 |
## Common ## Common

View file

@ -23920,7 +23920,7 @@
"section": "def-common.RegistryPackage", "section": "def-common.RegistryPackage",
"text": "RegistryPackage" "text": "RegistryPackage"
}, },
", \"internal\" | \"assets\" | \"elasticsearch\" | \"readme\" | \"data_streams\">" ", \"assets\" | \"internal\" | \"elasticsearch\" | \"readme\" | \"data_streams\">"
], ],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts", "path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet" title: "fleet"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin description: API docs for the fleet plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
--- ---
import fleetObj from './fleet.devdocs.json'; import fleetObj from './fleet.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/globalSearch
title: "globalSearch" title: "globalSearch"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the globalSearch plugin description: API docs for the globalSearch plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
--- ---
import globalSearchObj from './global_search.devdocs.json'; import globalSearchObj from './global_search.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/guidedOnboarding
title: "guidedOnboarding" title: "guidedOnboarding"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the guidedOnboarding plugin description: API docs for the guidedOnboarding plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
--- ---
import guidedOnboardingObj from './guided_onboarding.devdocs.json'; import guidedOnboardingObj from './guided_onboarding.devdocs.json';

View file

@ -201,7 +201,7 @@
"\nConvert instruction variant id into display text.\n" "\nConvert instruction variant id into display text.\n"
], ],
"signature": [ "signature": [
"(id: \"ESC\" | \"OSX\" | \"DEB\" | \"RPM\" | \"DOCKER\" | \"WINDOWS\" | \"NODE\" | \"DJANGO\" | \"FLASK\" | \"RAILS\" | \"RACK\" | \"JS\" | \"GO\" | \"JAVA\" | \"DOTNET\" | \"LINUX\" | \"PHP\" | \"FLEET\" | \"OPEN_TELEMETRY\" | \"OTHER_LINUX\") => any" "(id: \"ESC\" | \"OSX\" | \"DEB\" | \"RPM\" | \"DOCKER\" | \"WINDOWS\" | \"NODE\" | \"DJANGO\" | \"FLASK\" | \"RAILS\" | \"RACK\" | \"JS\" | \"GO\" | \"JAVA\" | \"DOTNET\" | \"LINUX\" | \"PHP\" | \"FLEET\" | \"OPEN_TELEMETRY\" | \"OTHER_LINUX\") => string"
], ],
"path": "src/plugins/home/common/instruction_variant.ts", "path": "src/plugins/home/common/instruction_variant.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/home
title: "home" title: "home"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the home plugin description: API docs for the home plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
--- ---
import homeObj from './home.devdocs.json'; import homeObj from './home.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable
title: "imageEmbeddable" title: "imageEmbeddable"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the imageEmbeddable plugin description: API docs for the imageEmbeddable plugin
date: 2023-08-22 date: 2023-08-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
--- ---
import imageEmbeddableObj from './image_embeddable.devdocs.json'; import imageEmbeddableObj from './image_embeddable.devdocs.json';

Some files were not shown because too many files have changed in this diff Show more