github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[api-docs] 2024-02-22 Daily api_docs build (#177540)

Browse source 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/621
This commit is contained in:
Kibana Machine 2024-02-22 01:00:02 -05:00 • committed by GitHub
parent ec5c7a402a
commit 21739f090d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
668 changed files with 1732 additions and 1207 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api_docs/actions.mdx
View file

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

2
api_docs/advanced_settings.mdx
View file

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

2
api_docs/ai_assistant_management_observability.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiAssistantManagementObservability
title: "aiAssistantManagementObservability"
image: https://source.unsplash.com/400x175/?github
description: API docs for the aiAssistantManagementObservability plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementObservability']
---
import aiAssistantManagementObservabilityObj from './ai_assistant_management_observability.devdocs.json';

2
api_docs/ai_assistant_management_selection.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiAssistantManagementSelection
title: "aiAssistantManagementSelection"
image: https://source.unsplash.com/400x175/?github
description: API docs for the aiAssistantManagementSelection plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
---
import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';

2
api_docs/aiops.mdx
View file

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

2
api_docs/alerting.mdx
View file

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

2
api_docs/apm.mdx
View file

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

2
api_docs/apm_data_access.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apmDataAccess
title: "apmDataAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apmDataAccess plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
---
import apmDataAccessObj from './apm_data_access.devdocs.json';

2
api_docs/asset_manager.mdx
View file

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

2
api_docs/banners.mdx
View file

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

2
api_docs/bfetch.mdx
View file

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

2
api_docs/canvas.mdx
View file

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

2
api_docs/cases.mdx
View file

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

4
api_docs/charts.devdocs.json
View file

@ -3397,7 +3397,7 @@
"ExternalPointerEventsSettings",
" | undefined>; pointBuffer?: ",
"MarkBuffer",
" | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ",
" | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
@ -3407,7 +3407,7 @@
"CustomXDomain",
" | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onResize?: \"ignore\" | undefined; onWillRender?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; } | undefined; }"
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onResize?: \"ignore\" | undefined; onWillRender?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; resizeDebounce?: number | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; } | undefined; }"
],
"path": "src/plugins/charts/common/static/overrides/settings.ts",
"deprecated": false,

2
api_docs/charts.mdx
View file

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

2
api_docs/cloud.mdx
View file

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

2
api_docs/cloud_data_migration.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration
title: "cloudDataMigration"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDataMigration plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';

2
api_docs/cloud_defend.mdx
View file

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

2
api_docs/cloud_experiments.mdx
View file

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

2
api_docs/cloud_security_posture.mdx
View file

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

2
api_docs/console.mdx
View file

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

2
api_docs/content_management.mdx
View file

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

2
api_docs/controls.mdx
View file

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

2
api_docs/custom_integrations.mdx
View file

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

2
api_docs/dashboard.mdx
View file

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

2
api_docs/dashboard_enhanced.mdx
View file

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

2
api_docs/data.mdx
View file

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

2
api_docs/data_query.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query
title: "data.query"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.query plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.devdocs.json';

2
api_docs/data_search.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search
title: "data.search"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.search plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
---
import dataSearchObj from './data_search.devdocs.json';

2
api_docs/data_view_editor.mdx
View file

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

2
api_docs/data_view_field_editor.mdx
View file

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

2
api_docs/data_view_management.mdx
View file

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

2
api_docs/data_views.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews
title: "dataViews"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViews plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
---
import dataViewsObj from './data_views.devdocs.json';

2
api_docs/data_visualizer.mdx
View file

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

2
api_docs/dataset_quality.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/datasetQuality
title: "datasetQuality"
image: https://source.unsplash.com/400x175/?github
description: API docs for the datasetQuality plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
---
import datasetQualityObj from './dataset_quality.devdocs.json';

4
api_docs/deprecations_by_api.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-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.
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -17,7 +17,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Referencing plugin(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibAlertingPluginApi" section="def-public.PluginSetupContract.registerNavigation" text="registerNavigation"/> | ml, stackAlerts | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | share, uiActions, guidedOnboarding, home, serverless, management, spaces, savedObjects, indexManagement, devTools, console, visualizations, dashboard, savedObjectsTagging, expressionXY, lens, expressionMetricVis, expressionGauge, security, alerting, triggersActionsUi, cases, aiops, licenseManagement, maps, dataVisualizer, ml, exploratoryView, fleet, metricsDataAccess, osquery, ingestPipelines, profiling, apm, expressionImage, expressionMetric, expressionError, expressionRevealImage, expressionRepeatImage, expressionShape, crossClusterReplication, graph, grokdebugger, indexLifecycleManagement, infra, logstash, monitoring, observabilityOnboarding, painlessLab, remoteClusters, rollup, searchprofiler, newsfeed, securitySolution, snapshotRestore, synthetics, transform, upgradeAssistant, uptime, ux, watcher, cloudDataMigration, filesManagement, kibanaOverview, visDefaultEditor, expressionHeatmap, expressionLegacyMetricVis, expressionPartitionVis, expressionTagcloud, visTypeTable, visTypeTimelion, visTypeTimeseries, visTypeVega, visTypeVislib | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | share, uiActions, guidedOnboarding, home, serverless, management, spaces, savedObjects, indexManagement, devTools, console, visualizations, dashboard, savedObjectsTagging, expressionXY, lens, expressionMetricVis, expressionGauge, security, alerting, triggersActionsUi, cases, aiops, licenseManagement, maps, dataVisualizer, ml, exploratoryView, fleet, metricsDataAccess, osquery, ingestPipelines, profiling, apm, expressionImage, expressionMetric, expressionError, expressionRevealImage, expressionRepeatImage, expressionShape, crossClusterReplication, graph, grokdebugger, indexLifecycleManagement, infra, logstash, monitoring, observabilityOnboarding, painlessLab, remoteClusters, rollup, searchprofiler, newsfeed, securitySolution, snapshotRestore, synthetics, transform, upgradeAssistant, uptime, watcher, cloudDataMigration, ux, filesManagement, kibanaOverview, visDefaultEditor, expressionHeatmap, expressionLegacyMetricVis, expressionPartitionVis, expressionTagcloud, visTypeTable, visTypeTimelion, visTypeTimeseries, visTypeVega, visTypeVislib | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | encryptedSavedObjects, actions, data, ml, logstash, securitySolution, cloudChat | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | actions, ml, savedObjectsTagging, enterpriseSearch | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject" text="SimpleSavedObject"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, savedObjects, visualizations, aiops, ml, dataVisualizer, dashboardEnhanced, graph, lens, securitySolution, eventAnnotation, @kbn/core-saved-objects-browser-mocks | - |

4
api_docs/deprecations_by_plugin.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-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.
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -1725,4 +1725,4 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [shared_imports.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/application/shared_imports.ts#:~:text=KibanaThemeProvider), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/application/index.tsx#:~:text=KibanaThemeProvider), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/application/index.tsx#:~:text=KibanaThemeProvider), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/application/index.tsx#:~:text=KibanaThemeProvider) | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24) | 8.8.0 |

2
api_docs/deprecations_by_team.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-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.
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

2
api_docs/dev_tools.mdx
View file

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

2
api_docs/discover.mdx
View file

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

2
api_docs/discover_enhanced.mdx
View file

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

2
api_docs/ecs_data_quality_dashboard.mdx
View file

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

2
api_docs/elastic_assistant.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/elasticAssistant
title: "elasticAssistant"
image: https://source.unsplash.com/400x175/?github
description: API docs for the elasticAssistant plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
---
import elasticAssistantObj from './elastic_assistant.devdocs.json';

2
api_docs/embeddable.mdx
View file

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

2
api_docs/embeddable_enhanced.mdx
View file

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

2
api_docs/encrypted_saved_objects.mdx
View file

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

2
api_docs/enterprise_search.mdx
View file

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

2
api_docs/es_ui_shared.mdx
View file

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

2
api_docs/event_annotation.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
title: "eventAnnotation"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotation plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
---
import eventAnnotationObj from './event_annotation.devdocs.json';

2
api_docs/event_annotation_listing.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotationListing
title: "eventAnnotationListing"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotationListing plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
---
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';

2
api_docs/event_log.mdx
View file

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

2
api_docs/exploratory_view.mdx
View file

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

2
api_docs/expression_error.mdx
View file

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

4
api_docs/expression_gauge.devdocs.json
View file

@ -1247,7 +1247,7 @@
"ExternalPointerEventsSettings",
" | undefined>; pointBuffer?: ",
"MarkBuffer",
" | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ",
" | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
@ -1257,7 +1257,7 @@
"CustomXDomain",
" | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onResize?: \"ignore\" | undefined; onWillRender?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial<Record<\"chart\", { title?: string | undefined; description?: string | undefined; }>>) | undefined; shouldUseVeil: boolean; setChartSize: (d: ",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onResize?: \"ignore\" | undefined; onWillRender?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; resizeDebounce?: number | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial<Record<\"chart\", { title?: string | undefined; description?: string | undefined; }>>) | undefined; setChartSize: (d: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",

2
api_docs/expression_gauge.mdx
View file

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

4
api_docs/expression_heatmap.devdocs.json
View file

@ -517,7 +517,7 @@
"ExternalPointerEventsSettings",
" | undefined>; pointBuffer?: ",
"MarkBuffer",
" | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ",
" | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
@ -527,7 +527,7 @@
"CustomXDomain",
" | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onResize?: \"ignore\" | undefined; onWillRender?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial<Record<\"chart\", { title?: string | undefined; description?: string | undefined; }>>) | undefined"
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onResize?: \"ignore\" | undefined; onWillRender?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; resizeDebounce?: number | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial<Record<\"chart\", { title?: string | undefined; description?: string | undefined; }>>) | undefined"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_functions.ts",
"deprecated": false,

2
api_docs/expression_heatmap.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap
title: "expressionHeatmap"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionHeatmap plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
---
import expressionHeatmapObj from './expression_heatmap.devdocs.json';

2
api_docs/expression_image.mdx
View file

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

2
api_docs/expression_legacy_metric_vis.mdx
View file

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

2
api_docs/expression_metric.mdx
View file

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

4
api_docs/expression_metric_vis.devdocs.json
View file

@ -894,7 +894,7 @@
"ExternalPointerEventsSettings",
" | undefined>; pointBuffer?: ",
"MarkBuffer",
" | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ",
" | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
@ -904,7 +904,7 @@
"CustomXDomain",
" | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onResize?: \"ignore\" | undefined; onWillRender?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial<Record<\"chart\", { title?: string | undefined; description?: string | undefined; }>>) | undefined"
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onResize?: \"ignore\" | undefined; onWillRender?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; resizeDebounce?: number | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial<Record<\"chart\", { title?: string | undefined; description?: string | undefined; }>>) | undefined"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,

2
api_docs/expression_metric_vis.mdx
View file

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

2
api_docs/expression_partition_vis.mdx
View file

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

2
api_docs/expression_repeat_image.mdx
View file

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

2
api_docs/expression_reveal_image.mdx
View file

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

2
api_docs/expression_shape.mdx
View file

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

2
api_docs/expression_tagcloud.mdx
View file

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

4
api_docs/expression_x_y.devdocs.json
View file

@ -1968,7 +1968,7 @@
"ExternalPointerEventsSettings",
" | undefined>; pointBuffer?: ",
"MarkBuffer",
" | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ",
" | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
@ -1978,7 +1978,7 @@
"CustomXDomain",
" | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onResize?: \"ignore\" | undefined; onWillRender?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial<Record<\"chart\", { title?: string | undefined; description?: string | undefined; }>>) | undefined"
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onResize?: \"ignore\" | undefined; onWillRender?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; resizeDebounce?: number | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial<Record<\"chart\", { title?: string | undefined; description?: string | undefined; }>>) | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,

2
api_docs/expression_x_y.mdx
View file

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

132
api_docs/expressions.devdocs.json
View file

@ -3794,7 +3794,7 @@
"id": "def-public.ExpressionRenderHandler.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "{\n onRenderError,\n renderMode,\n syncColors,\n syncTooltips,\n syncCursor,\n shouldUseSizeTransitionVeil,\n interactive,\n hasCompatibleActions = async () => false,\n getCompatibleCellValueActions = async () => [],\n executionContext,\n }",
"label": "{\n onRenderError,\n renderMode,\n syncColors,\n syncTooltips,\n syncCursor,\n interactive,\n hasCompatibleActions = async () => false,\n getCompatibleCellValueActions = async () => [],\n executionContext,\n }",
"description": [],
"signature": [
"ExpressionRenderHandlerParams"
@ -7276,24 +7276,6 @@
"children": [],
"returnComment": []
},
{
"parentPluginId": "expressions",
"id": "def-public.ExecutionContext.shouldUseSizeTransitionVeil",
"type": "Function",
"tags": [],
"label": "shouldUseSizeTransitionVeil",
"description": [
"\nReturns whether or not to use the size transition veil when resizing visualizations."
],
"signature": [
"(() => boolean) | undefined"
],
"path": "src/plugins/expressions/common/execution/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "expressions",
"id": "def-public.ExecutionContext.getExecutionContext",
@ -10927,20 +10909,6 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressions",
"id": "def-public.IExpressionLoaderParams.shouldUseSizeTransitionVeil",
"type": "CompoundType",
"tags": [],
"label": "shouldUseSizeTransitionVeil",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/expressions/public/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressions",
"id": "def-public.IExpressionLoaderParams.hasCompatibleActions",
@ -11386,22 +11354,6 @@
"children": [],
"returnComment": []
},
{
"parentPluginId": "expressions",
"id": "def-public.IInterpreterRenderHandlers.shouldUseSizeTransitionVeil",
"type": "Function",
"tags": [],
"label": "shouldUseSizeTransitionVeil",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/expressions/common/expression_renderers/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "expressions",
"id": "def-public.IInterpreterRenderHandlers.uiState",
@ -18753,24 +18705,6 @@
"children": [],
"returnComment": []
},
{
"parentPluginId": "expressions",
"id": "def-server.ExecutionContext.shouldUseSizeTransitionVeil",
"type": "Function",
"tags": [],
"label": "shouldUseSizeTransitionVeil",
"description": [
"\nReturns whether or not to use the size transition veil when resizing visualizations."
],
"signature": [
"(() => boolean) | undefined"
],
"path": "src/plugins/expressions/common/execution/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "expressions",
"id": "def-server.ExecutionContext.getExecutionContext",
@ -21458,22 +21392,6 @@
"children": [],
"returnComment": []
},
{
"parentPluginId": "expressions",
"id": "def-server.IInterpreterRenderHandlers.shouldUseSizeTransitionVeil",
"type": "Function",
"tags": [],
"label": "shouldUseSizeTransitionVeil",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/expressions/common/expression_renderers/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "expressions",
"id": "def-server.IInterpreterRenderHandlers.uiState",
@ -30842,24 +30760,6 @@
"children": [],
"returnComment": []
},
{
"parentPluginId": "expressions",
"id": "def-common.ExecutionContext.shouldUseSizeTransitionVeil",
"type": "Function",
"tags": [],
"label": "shouldUseSizeTransitionVeil",
"description": [
"\nReturns whether or not to use the size transition veil when resizing visualizations."
],
"signature": [
"(() => boolean) | undefined"
],
"path": "src/plugins/expressions/common/execution/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "expressions",
"id": "def-common.ExecutionContext.getExecutionContext",
@ -32514,20 +32414,6 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressions",
"id": "def-common.ExpressionExecutionParams.shouldUseSizeTransitionVeil",
"type": "CompoundType",
"tags": [],
"label": "shouldUseSizeTransitionVeil",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/expressions/common/service/expressions_services.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressions",
"id": "def-common.ExpressionExecutionParams.inspectorAdapters",
@ -35786,22 +35672,6 @@
"children": [],
"returnComment": []
},
{
"parentPluginId": "expressions",
"id": "def-common.IInterpreterRenderHandlers.shouldUseSizeTransitionVeil",
"type": "Function",
"tags": [],
"label": "shouldUseSizeTransitionVeil",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/expressions/common/expression_renderers/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "expressions",
"id": "def-common.IInterpreterRenderHandlers.uiState",

4
api_docs/expressions.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions
title: "expressions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressions plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
---
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 |
|-------------------|-----------|------------------------|-----------------|
| 2224 | 17 | 1762 | 5 |
| 2216 | 17 | 1757 | 5 |
## Client

2
api_docs/features.mdx
View file

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

2
api_docs/field_formats.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats
title: "fieldFormats"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldFormats plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
---
import fieldFormatsObj from './field_formats.devdocs.json';

2
api_docs/file_upload.mdx
View file

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

2
api_docs/files.mdx
View file

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

2
api_docs/files_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement
title: "filesManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the filesManagement plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
---
import filesManagementObj from './files_management.devdocs.json';

2
api_docs/fleet.mdx
View file

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

2
api_docs/global_search.mdx
View file

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

2
api_docs/guided_onboarding.mdx
View file

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

2
api_docs/home.mdx
View file

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

2
api_docs/image_embeddable.mdx
View file

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

2
api_docs/index_lifecycle_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement
title: "indexLifecycleManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexLifecycleManagement plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
---
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';

2
api_docs/index_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement
title: "indexManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexManagement plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';

2
api_docs/infra.mdx
View file

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

2
api_docs/ingest_pipelines.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ingestPipelines
title: "ingestPipelines"
image: https://source.unsplash.com/400x175/?github
description: API docs for the ingestPipelines plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ingestPipelines']
---
import ingestPipelinesObj from './ingest_pipelines.devdocs.json';

2
api_docs/inspector.mdx
View file

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

2
api_docs/interactive_setup.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup
title: "interactiveSetup"
image: https://source.unsplash.com/400x175/?github
description: API docs for the interactiveSetup plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
---
import interactiveSetupObj from './interactive_setup.devdocs.json';

2
api_docs/kbn_ace.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ace
title: "@kbn/ace"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ace plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
---
import kbnAceObj from './kbn_ace.devdocs.json';

2
api_docs/kbn_actions_types.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-actions-types
title: "@kbn/actions-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/actions-types plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/actions-types']
---
import kbnActionsTypesObj from './kbn_actions_types.devdocs.json';

2
api_docs/kbn_aiops_components.mdx
View file

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

2
api_docs/kbn_aiops_utils.mdx
View file

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

2
api_docs/kbn_alerting_api_integration_helpers.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-api-integration-helpers
title: "@kbn/alerting-api-integration-helpers"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerting-api-integration-helpers plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-api-integration-helpers']
---
import kbnAlertingApiIntegrationHelpersObj from './kbn_alerting_api_integration_helpers.devdocs.json';

2
api_docs/kbn_alerting_state_types.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-state-types
title: "@kbn/alerting-state-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerting-state-types plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types']
---
import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json';

2
api_docs/kbn_alerting_types.mdx
View file

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

2
api_docs/kbn_alerts_as_data_utils.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-as-data-utils
title: "@kbn/alerts-as-data-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts-as-data-utils plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils']
---
import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json';

2
api_docs/kbn_alerts_ui_shared.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-ui-shared
title: "@kbn/alerts-ui-shared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts-ui-shared plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared']
---
import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.devdocs.json';

2
api_docs/kbn_analytics.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics
title: "@kbn/analytics"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
---
import kbnAnalyticsObj from './kbn_analytics.devdocs.json';

431
api_docs/kbn_analytics_client.devdocs.json
View file

@ -25,7 +25,9 @@
"type": "Function",
"tags": [],
"label": "createAnalytics",
"description": ["\nCreates an {@link AnalyticsClient}."],
"description": [
"\nCreates an {@link AnalyticsClient}."
],
"signature": [
"(initContext: ",
{
@ -83,7 +85,9 @@
"type": "Interface",
"tags": [],
"label": "AnalyticsClientInitContext",
"description": ["\nGeneral settings of the analytics client"],
"description": [
"\nGeneral settings of the analytics client"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -94,7 +98,9 @@
"type": "boolean",
"tags": [],
"label": "isDev",
"description": ["\nBoolean indicating if it's running in developer mode."],
"description": [
"\nBoolean indicating if it's running in developer mode."
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false
@ -108,7 +114,9 @@
"description": [
"\nSpecify if the shippers should send their data to the production or staging environments."
],
"signature": ["\"production\" | \"staging\""],
"signature": [
"\"production\" | \"staging\""
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false
@ -119,7 +127,9 @@
"type": "Object",
"tags": [],
"label": "logger",
"description": ["\nApplication-provided logger."],
"description": [
"\nApplication-provided logger."
],
"signature": [
{
"pluginId": "@kbn/logging",
@ -142,7 +152,9 @@
"type": "Interface",
"tags": [],
"label": "ContextProviderOpts",
"description": ["\nDefinition of a context provider"],
"description": [
"\nDefinition of a context provider"
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -163,7 +175,9 @@
"type": "string",
"tags": [],
"label": "name",
"description": ["\nThe name of the provider."],
"description": [
"\nThe name of the provider."
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false
@ -174,8 +188,13 @@
"type": "Object",
"tags": [],
"label": "context$",
"description": ["\nObservable that emits the custom context."],
"signature": ["Observable", "<Context>"],
"description": [
"\nObservable that emits the custom context."
],
"signature": [
"Observable",
"<Context>"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false
@ -213,7 +232,9 @@
"type": "Interface",
"tags": [],
"label": "Event",
"description": ["\nDefinition of the full event structure"],
"description": [
"\nDefinition of the full event structure"
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -234,7 +255,9 @@
"type": "string",
"tags": [],
"label": "timestamp",
"description": ["\nThe time the event was generated in ISO format."],
"description": [
"\nThe time the event was generated in ISO format."
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -245,7 +268,9 @@
"type": "string",
"tags": [],
"label": "event_type",
"description": ["\nThe event type."],
"description": [
"\nThe event type."
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -256,8 +281,12 @@
"type": "Uncategorized",
"tags": [],
"label": "properties",
"description": ["\nThe specific properties of the event type."],
"signature": ["Properties"],
"description": [
"\nThe specific properties of the event type."
],
"signature": [
"Properties"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -268,7 +297,9 @@
"type": "Object",
"tags": [],
"label": "context",
"description": ["\nThe {@link EventContext} enriched during the processing pipeline."],
"description": [
"\nThe {@link EventContext} enriched during the processing pipeline."
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -304,8 +335,12 @@
"type": "string",
"tags": [],
"label": "cluster_uuid",
"description": ["\nThe UUID of the cluster"],
"signature": ["string | undefined"],
"description": [
"\nThe UUID of the cluster"
],
"signature": [
"string | undefined"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -316,8 +351,12 @@
"type": "string",
"tags": [],
"label": "cluster_name",
"description": ["\nThe name of the cluster."],
"signature": ["string | undefined"],
"description": [
"\nThe name of the cluster."
],
"signature": [
"string | undefined"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -328,8 +367,12 @@
"type": "string",
"tags": [],
"label": "license_id",
"description": ["\nThe license ID."],
"signature": ["string | undefined"],
"description": [
"\nThe license ID."
],
"signature": [
"string | undefined"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -340,8 +383,12 @@
"type": "string",
"tags": [],
"label": "userId",
"description": ["\nThe unique user ID."],
"signature": ["string | undefined"],
"description": [
"\nThe unique user ID."
],
"signature": [
"string | undefined"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -352,8 +399,12 @@
"type": "string",
"tags": [],
"label": "cloudId",
"description": ["\nThe Cloud ID."],
"signature": ["string | undefined"],
"description": [
"\nThe Cloud ID."
],
"signature": [
"string | undefined"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -367,7 +418,9 @@
"description": [
"\n`true` if the user is logged in via the Elastic Cloud authentication provider."
],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -378,8 +431,12 @@
"type": "string",
"tags": [],
"label": "version",
"description": ["\nThe product's version."],
"signature": ["string | undefined"],
"description": [
"\nThe product's version."
],
"signature": [
"string | undefined"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -390,8 +447,12 @@
"type": "string",
"tags": [],
"label": "pageName",
"description": ["\nThe name of the current page."],
"signature": ["string | undefined"],
"description": [
"\nThe name of the current page."
],
"signature": [
"string | undefined"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -402,8 +463,12 @@
"type": "string",
"tags": [],
"label": "applicationId",
"description": ["\nThe current application ID."],
"signature": ["string | undefined"],
"description": [
"\nThe current application ID."
],
"signature": [
"string | undefined"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -414,8 +479,12 @@
"type": "string",
"tags": [],
"label": "entityId",
"description": ["\nThe current entity ID (dashboard ID, visualization ID, etc.)."],
"signature": ["string | undefined"],
"description": [
"\nThe current entity ID (dashboard ID, visualization ID, etc.)."
],
"signature": [
"string | undefined"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -426,8 +495,12 @@
"type": "IndexSignature",
"tags": [],
"label": "[key: string]: unknown",
"description": ["\nAdditional keys are allowed."],
"signature": ["[key: string]: unknown"],
"description": [
"\nAdditional keys are allowed."
],
"signature": [
"[key: string]: unknown"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -441,7 +514,9 @@
"type": "Interface",
"tags": [],
"label": "EventTypeOpts",
"description": ["\nDefinition of an Event Type."],
"description": [
"\nDefinition of an Event Type."
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -462,7 +537,9 @@
"type": "string",
"tags": [],
"label": "eventType",
"description": ["\nThe event type's unique name."],
"description": [
"\nThe event type's unique name."
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false
@ -500,7 +577,9 @@
"type": "Interface",
"tags": [],
"label": "IAnalyticsClient",
"description": ["\nAnalytics client's public APIs"],
"description": [
"\nAnalytics client's public APIs"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -509,9 +588,13 @@
"parentPluginId": "@kbn/analytics-client",
"id": "def-common.IAnalyticsClient.reportEvent",
"type": "Function",
"tags": ["track-adoption"],
"tags": [
"track-adoption"
],
"label": "reportEvent",
"description": ["\nReports a telemetry event."],
"description": [
"\nReports a telemetry event."
],
"signature": [
"<EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void"
],
@ -659,6 +742,10 @@
"plugin": "apm",
"path": "x-pack/plugins/apm/public/services/telemetry/telemetry_client.ts"
},
{
"plugin": "reporting",
"path": "x-pack/plugins/reporting/server/usage/event_tracker.ts"
},
{
"plugin": "elasticAssistant",
"path": "x-pack/plugins/elastic_assistant/server/lib/langchain/elasticsearch_store/elasticsearch_store.ts"
@ -1051,8 +1138,12 @@
"type": "string",
"tags": [],
"label": "eventType",
"description": ["The event type registered via the `registerEventType` API."],
"signature": ["string"],
"description": [
"The event type registered via the `registerEventType` API."
],
"signature": [
"string"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1067,7 +1158,9 @@
"description": [
"The properties matching the schema declared in the `registerEventType` API."
],
"signature": ["EventTypeData"],
"signature": [
"EventTypeData"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1106,7 +1199,9 @@
"type": "Object",
"tags": [],
"label": "eventTypeOps",
"description": ["The definition of the event type {@link EventTypeOpts }."],
"description": [
"The definition of the event type {@link EventTypeOpts }."
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -1171,7 +1266,9 @@
"type": "Object",
"tags": [],
"label": "Shipper",
"description": ["The {@link IShipper } class to instantiate the shipper."],
"description": [
"The {@link IShipper } class to instantiate the shipper."
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -1193,8 +1290,12 @@
"type": "Uncategorized",
"tags": [],
"label": "shipperConfig",
"description": ["The config specific to the Shipper to instantiate."],
"signature": ["ShipperConfig"],
"description": [
"The config specific to the Shipper to instantiate."
],
"signature": [
"ShipperConfig"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1257,7 +1358,9 @@
"type": "Object",
"tags": [],
"label": "optInConfig",
"description": ["{@link OptInConfig }"],
"description": [
"{@link OptInConfig }"
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -1279,9 +1382,13 @@
"parentPluginId": "@kbn/analytics-client",
"id": "def-common.IAnalyticsClient.registerContextProvider",
"type": "Function",
"tags": ["track-adoption"],
"tags": [
"track-adoption"
],
"label": "registerContextProvider",
"description": ["\nRegisters the context provider to enrich any reported events."],
"description": [
"\nRegisters the context provider to enrich any reported events."
],
"signature": [
"<Context>(contextProviderOpts: ",
{
@ -1561,7 +1668,9 @@
"type": "Object",
"tags": [],
"label": "contextProviderOpts",
"description": ["{@link ContextProviderOpts }"],
"description": [
"{@link ContextProviderOpts }"
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -1589,7 +1698,9 @@
"description": [
"\nRemoves the context provider and stop enriching the events from its context."
],
"signature": ["(contextProviderName: string) => void"],
"signature": [
"(contextProviderName: string) => void"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1600,8 +1711,12 @@
"type": "string",
"tags": [],
"label": "contextProviderName",
"description": ["The name of the context provider to remove."],
"signature": ["string"],
"description": [
"The name of the context provider to remove."
],
"signature": [
"string"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1616,7 +1731,9 @@
"type": "Object",
"tags": [],
"label": "telemetryCounter$",
"description": ["\nObservable to emit the stats of the processed events."],
"description": [
"\nObservable to emit the stats of the processed events."
],
"signature": [
"Observable",
"<",
@ -1642,7 +1759,9 @@
"description": [
"\nForces all shippers to send all their enqueued events and fulfills the returned promise."
],
"signature": ["() => Promise<void>"],
"signature": [
"() => Promise<void>"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1655,8 +1774,12 @@
"type": "Function",
"tags": [],
"label": "shutdown",
"description": ["\nStops the client. Flushing any pending events in the process."],
"signature": ["() => Promise<void>"],
"description": [
"\nStops the client. Flushing any pending events in the process."
],
"signature": [
"() => Promise<void>"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1672,7 +1795,9 @@
"type": "Interface",
"tags": [],
"label": "IShipper",
"description": ["\nBasic structure of a Shipper"],
"description": [
"\nBasic structure of a Shipper"
],
"path": "packages/analytics/client/src/shippers/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1683,7 +1808,9 @@
"type": "Function",
"tags": [],
"label": "reportEvents",
"description": ["\nAdapts and ships the event to the persisting/analytics solution."],
"description": [
"\nAdapts and ships the event to the persisting/analytics solution."
],
"signature": [
"(events: ",
{
@ -1705,7 +1832,9 @@
"type": "Array",
"tags": [],
"label": "events",
"description": ["batched events {@link Event }"],
"description": [
"batched events {@link Event }"
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -1733,7 +1862,9 @@
"description": [
"\nStops/restarts the shipping mechanism based on the value of isOptedIn"
],
"signature": ["(isOptedIn: boolean) => void"],
"signature": [
"(isOptedIn: boolean) => void"
],
"path": "packages/analytics/client/src/shippers/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1744,8 +1875,12 @@
"type": "boolean",
"tags": [],
"label": "isOptedIn",
"description": ["`true` for resume sending events. `false` to stop."],
"signature": ["boolean"],
"description": [
"`true` for resume sending events. `false` to stop."
],
"signature": [
"boolean"
],
"path": "packages/analytics/client/src/shippers/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1784,7 +1919,9 @@
"type": "Object",
"tags": [],
"label": "newContext",
"description": ["The full new context to set {@link EventContext }"],
"description": [
"The full new context to set {@link EventContext }"
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -1808,7 +1945,9 @@
"type": "Object",
"tags": [],
"label": "telemetryCounter$",
"description": ["\nObservable to emit the stats of the processed events."],
"description": [
"\nObservable to emit the stats of the processed events."
],
"signature": [
"Observable",
"<",
@ -1831,8 +1970,12 @@
"type": "Function",
"tags": [],
"label": "flush",
"description": ["\nSends all the enqueued events and fulfills the returned promise."],
"signature": ["() => Promise<void>"],
"description": [
"\nSends all the enqueued events and fulfills the returned promise."
],
"signature": [
"() => Promise<void>"
],
"path": "packages/analytics/client/src/shippers/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1845,8 +1988,12 @@
"type": "Function",
"tags": [],
"label": "shutdown",
"description": ["\nShutdown the shipper."],
"signature": ["() => void"],
"description": [
"\nShutdown the shipper."
],
"signature": [
"() => void"
],
"path": "packages/analytics/client/src/shippers/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1862,7 +2009,9 @@
"type": "Interface",
"tags": [],
"label": "OptInConfig",
"description": ["\n"],
"description": [
"\n"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1935,7 +2084,9 @@
"type": "boolean",
"tags": [],
"label": "enabled",
"description": ["\nThe event type is globally enabled."],
"description": [
"\nThe event type is globally enabled."
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1949,7 +2100,9 @@
"description": [
"\nControls if an event type should be disabled for a specific type of shipper."
],
"signature": ["Record<string, boolean | undefined> | undefined"],
"signature": [
"Record<string, boolean | undefined> | undefined"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1963,7 +2116,9 @@
"type": "Interface",
"tags": [],
"label": "RegisterShipperOpts",
"description": ["\nOptional options to register a shipper"],
"description": [
"\nOptional options to register a shipper"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1976,7 +2131,9 @@
"type": "Interface",
"tags": [],
"label": "SchemaArray",
"description": ["\nSchema to represent an array"],
"description": [
"\nSchema to represent an array"
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -2005,8 +2162,12 @@
"type": "string",
"tags": [],
"label": "type",
"description": ["The type must be an array"],
"signature": ["\"array\""],
"description": [
"The type must be an array"
],
"signature": [
"\"array\""
],
"path": "packages/analytics/client/src/schema/types.ts",
"deprecated": false,
"trackAdoption": false
@ -2100,7 +2261,9 @@
"type": "Interface",
"tags": [],
"label": "SchemaChildValue",
"description": ["\nSchema to define a primitive value"],
"description": [
"\nSchema to define a primitive value"
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -2121,7 +2284,9 @@
"type": "Uncategorized",
"tags": [],
"label": "type",
"description": ["The type of the value"],
"description": [
"The type of the value"
],
"signature": [
"NonNullable<Value> extends string | Date ? ",
{
@ -2158,7 +2323,9 @@
"type": "CompoundType",
"tags": [],
"label": "_meta",
"description": ["Meta properties of the value: description and is optional"],
"description": [
"Meta properties of the value: description and is optional"
],
"signature": [
"{ description: string; } & ",
{
@ -2183,7 +2350,9 @@
"type": "Interface",
"tags": [],
"label": "SchemaMeta",
"description": ["\nSchema meta with optional description"],
"description": [
"\nSchema meta with optional description"
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -2204,7 +2373,9 @@
"type": "CompoundType",
"tags": [],
"label": "_meta",
"description": ["Meta properties of the pass through: description and is optional"],
"description": [
"Meta properties of the pass through: description and is optional"
],
"signature": [
"({ description?: string | undefined; } & ",
{
@ -2229,7 +2400,9 @@
"type": "Interface",
"tags": [],
"label": "SchemaObject",
"description": ["\nSchema to represent an object"],
"description": [
"\nSchema to represent an object"
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -2285,7 +2458,9 @@
"type": "Interface",
"tags": [],
"label": "ShipperClassConstructor",
"description": ["\nConstructor of a {@link IShipper}"],
"description": [
"\nConstructor of a {@link IShipper}"
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -2306,7 +2481,9 @@
"type": "string",
"tags": [],
"label": "shipperName",
"description": ["\nThe shipper's unique name"],
"description": [
"\nThe shipper's unique name"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false
@ -2317,8 +2494,12 @@
"type": "Function",
"tags": [],
"label": "new",
"description": ["\nThe constructor"],
"signature": ["any"],
"description": [
"\nThe constructor"
],
"signature": [
"any"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -2329,8 +2510,12 @@
"type": "Uncategorized",
"tags": [],
"label": "config",
"description": ["The shipper's custom config"],
"signature": ["Config"],
"description": [
"The shipper's custom config"
],
"signature": [
"Config"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -2342,7 +2527,9 @@
"type": "Object",
"tags": [],
"label": "initContext",
"description": ["Common context {@link AnalyticsClientInitContext }"],
"description": [
"Common context {@link AnalyticsClientInitContext }"
],
"signature": [
{
"pluginId": "@kbn/analytics-client",
@ -2369,7 +2556,9 @@
"type": "Interface",
"tags": [],
"label": "TelemetryCounter",
"description": ["\nShape of the events emitted by the telemetryCounter$ observable"],
"description": [
"\nShape of the events emitted by the telemetryCounter$ observable"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -2380,7 +2569,9 @@
"type": "CompoundType",
"tags": [],
"label": "type",
"description": ["\n{@link TelemetryCounterType}"],
"description": [
"\n{@link TelemetryCounterType}"
],
"signature": [
"\"succeeded\" | \"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"dropped\""
],
@ -2407,7 +2598,9 @@
"type": "string",
"tags": [],
"label": "event_type",
"description": ["\nThe event type the success/failure/drop event refers to."],
"description": [
"\nThe event type the success/failure/drop event refers to."
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -2431,7 +2624,9 @@
"type": "number",
"tags": [],
"label": "count",
"description": ["\nThe number of events that this counter refers to."],
"description": [
"\nThe number of events that this counter refers to."
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false
@ -2448,8 +2643,12 @@
"type": "Type",
"tags": [],
"label": "AllowedSchemaBooleanTypes",
"description": ["Types matching boolean values"],
"signature": ["\"boolean\""],
"description": [
"Types matching boolean values"
],
"signature": [
"\"boolean\""
],
"path": "packages/analytics/client/src/schema/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -2461,7 +2660,9 @@
"type": "Type",
"tags": [],
"label": "AllowedSchemaNumberTypes",
"description": ["Types matching number values"],
"description": [
"Types matching number values"
],
"signature": [
"\"date\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\""
],
@ -2476,8 +2677,12 @@
"type": "Type",
"tags": [],
"label": "AllowedSchemaStringTypes",
"description": ["Types matching string values"],
"signature": ["\"keyword\" | \"text\" | \"date\""],
"description": [
"Types matching string values"
],
"signature": [
"\"keyword\" | \"text\" | \"date\""
],
"path": "packages/analytics/client/src/schema/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -2489,7 +2694,9 @@
"type": "Type",
"tags": [],
"label": "AllowedSchemaTypes",
"description": ["\nPossible type values in the schema"],
"description": [
"\nPossible type values in the schema"
],
"signature": [
"\"boolean\" | \"keyword\" | \"text\" | \"date\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\""
],
@ -2507,7 +2714,9 @@
"description": [
"\nEvent Type used for indexed structures. Only used to improve the readability of the types"
],
"signature": ["string"],
"signature": [
"string"
],
"path": "packages/analytics/client/src/events/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -2519,7 +2728,9 @@
"type": "Type",
"tags": [],
"label": "PossibleSchemaTypes",
"description": ["\nHelper to ensure the declared types match the schema types"],
"description": [
"\nHelper to ensure the declared types match the schema types"
],
"signature": [
"Value extends string | Date ? ",
{
@ -2557,7 +2768,9 @@
"type": "Type",
"tags": [],
"label": "RootSchema",
"description": ["\nSchema definition to match the structure of the properties provided.\n"],
"description": [
"\nSchema definition to match the structure of the properties provided.\n"
],
"signature": [
"{ [Key in keyof Required<Base>]: ",
{
@ -2580,7 +2793,9 @@
"type": "Type",
"tags": [],
"label": "SchemaMetaOptional",
"description": ["\nEnforces { optional: true } if the value can be undefined"],
"description": [
"\nEnforces { optional: true } if the value can be undefined"
],
"signature": [
"unknown extends Value ? { optional?: boolean | undefined; } : undefined extends Value ? { optional: true; } : { optional?: false | undefined; }"
],
@ -2679,7 +2894,9 @@
"description": [
"\nShipper Name used for indexed structures. Only used to improve the readability of the types"
],
"signature": ["string"],
"signature": [
"string"
],
"path": "packages/analytics/client/src/analytics_client/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -2705,4 +2922,4 @@
],
"objects": []
}
}
}

2
api_docs/kbn_analytics_client.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client
title: "@kbn/analytics-client"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-client plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client']
---
import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json';

2
api_docs/kbn_analytics_collection_utils.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-collection-utils
title: "@kbn/analytics-collection-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-collection-utils plugin
date: 2024-02-21
date: 2024-02-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-collection-utils']
---
import kbnAnalyticsCollectionUtilsObj from './kbn_analytics_collection_utils.devdocs.json';

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